Endpoints

PreviousDirecting to Checkout NextOverview

Last updated 9 months ago

Was this helpful?

Fetch the custom pages associated with the store.

get

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

Path parameters

tokenstringrequired

The webstore identifier.

Example: some-uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/pages'

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

Successful response returns the webstore's pages.

Fetch a basket from a webstore by its identifier

get

Gets a basket associated with the provided identifier.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}'

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "support@tebex.io",
    "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"
    }
  }
}

Successful response returns the basket information.

Get authentication links for a basket.

get

Fetches a basket's auth URL.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

returnUrlstringrequired

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

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/auth?returnUrl={returnUrl}'

200

422

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

Successful response returns the basket auth information.

Gets all categories available in the webstore.

get

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

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/categories'

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "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"
    }
  ]
}

Successful response returns a list of category information.

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

get

Gets all categories from a webstore including packages.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/categories?includePackages=1'

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "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"
    }
  ]
}

Successful response returns a list of category information.

Gets information about a specific category

get

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

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

categoryIdstringrequired

The ID of the category to fetch.

Example: 127244343

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/categories/{categoryId}'

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "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"
    }
  ]
}

Successful response returns the category without package information.

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

get

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

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

categoryIdstringrequired

The ID of the category to fetch.

Example: 127244343

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/categories/{categoryId}?includePackages=1'

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "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"
    }
  ]
}

Successful response returns the category with package information.

Fetch a package from a webstore by its identifier

get

Gets a package from a webstore by ID.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

packageIdnumberrequired

The package's ID.

Example: 1272441812

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/packages/{packageId}'

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

Successful response returns the package information.

Fetch all packages from a webstore

get

Gets all packages from a webstore.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/packages'

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

Successful response returns a list of package information.

Fetch a package from a webstore by its identifier

get

Gets all packages from a webstore.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

ipAddressstringrequired

An IP address can be provided with authenticated requests.

Example: 127.0.0.1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/packages?ipAddress={ipAddress}'

200

422

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

Successful response returns a list of package information.

Fetch a package from a webstore by its identifier

get

Gets all packages from a webstore.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/packages?basketIdent={basketIdent}'

200

422

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

Successful response returns a list of package information.

Fetch a package from a webstore by its identifier

get

Gets all packages from a webstore.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

ipAddressstringrequired

An IP address can be provided with authenticated requests.

Example: 127.0.0.1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/packages?ipAddress={ipAddress}&basketIdent={basketIdent}'

200

422

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

Successful response returns a list of package information.

Remove a creator code from the basket.

post

Applies a creator code to a basket.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes/remove'

200

422

No body

Creator code removed successfully.

Remove a coupon from the basket.

post

Removes a coupon code from a basket

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons/remove'

200

422

No body

Successful response.

Fetch a webstore by its identifier

get

Gets the webstore associated with the provided identifier.

Path parameters

tokenstringrequired

The webstore identifier.

Example: some-uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}'

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

Successful response returns the webstore's information.

Create a new basket

post

Creates a new basket for use during checkout.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

Body

complete_urlstringoptional

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

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

cancel_urlstringoptional

A URL the user can return to when cancelling checkout.

Example: https://tebex.io/

customobjectoptional

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

Example: {"foo":"bar"}

complete_auto_redirectbooleanoptional

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

Example: true

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets' \
  --header 'Content-Type: application/json' \
  --data '{
    "complete_url": "https://example.tebex.io/thank-you",
    "cancel_url": "https://tebex.io/",
    "custom": {
      "foo": "bar"
    },
    "complete_auto_redirect": true
  }'

200

422

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "support@tebex.io",
    "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"
    }
  }
}

Successful response returns the basket information.

Apply a creator code to a basket.

post

Applies a creator code to a basket.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

creator_codestringoptional

Example: Academy10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes' \
  --header 'Content-Type: application/json' \
  --data '{
    "creator_code": "Academy10"
  }'

200

422

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "support@tebex.io",
    "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"
    }
  }
}

Successful response returns the basket.

Apply a gift card to a basket.

post

Applies a creator code to a basket.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

card_numberstringoptional

Example: 0127 0244 7210 1111

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards' \
  --header 'Content-Type: application/json' \
  --data '{
    "card_number": "0127 0244 7210 1111"
  }'

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "support@tebex.io",
    "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"
    }
  }
}

Successful response returns the basket.

Remove a gift card from the basket.

post

Removes a gift card from the basket.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

card_numberstringoptional

Example: 0127 0244 7210 1111

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards/remove' \
  --header 'Content-Type: application/json' \
  --data '{
    "card_number": "0127 0244 7210 1111"
  }'

200

422

No body

Gift card removed successfully.

Apply a coupon to a basket.

post

Applies a creator code to a basket.

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

coupon_codestringoptional

Example: Academy10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons' \
  --header 'Content-Type: application/json' \
  --data '{
    "coupon_code": "Academy10"
  }'

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "support@tebex.io",
    "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"
    }
  }
}

Successful response returns the basket.

Add a package to a basket

post

Add a package with the given ID to the basket.

Path parameters

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

package_idstringoptional

Example: 6276316

quantitynumberoptional

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/baskets/{basketIdent}/packages' \
  --header 'Content-Type: application/json' \
  --data '{
    "package_id": 6276316,
    "quantity": 1
  }'

200

422

{
  "id": 244127617,
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "complete": false,
  "email": "support@tebex.io",
  "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"
  }
}

Successful response.

Remove a package from a basket

post

Remove the given package ID from the basket.

Path parameters

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

package_idstringoptional

Example: 6276316

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/baskets/{basketIdent}/packages/remove' \
  --header 'Content-Type: application/json' \
  --data '{
    "package_id": 6276316
  }'

200

422

{
  "id": 244127617,
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "complete": false,
  "email": "support@tebex.io",
  "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"
  }
}

Successful response returns the basket.

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

put

Sets the quantity of the given item in the basket.

Path parameters

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

packageIdnumberrequired

The package identifier.

Example: 6276316

Body

quantitynumberoptional

Example: 1

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://headless.tebex.io/api/baskets/{basketIdent}/packages/{packageId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "quantity": 1
  }'

200

422

No body

Successful response.

Webstores

Baskets

Categories

Package

Creator Codes

Gift Cards

Coupons

Adding / Removing Packages

Updating Quantities

Webstores

Baskets

Categories

Package

Creator Codes

Gift Cards

Coupons

Adding / Removing Packages

Updating Quantities

Fetch the custom pages associated with the store.

Fetch a basket from a webstore by its identifier

Get authentication links for a basket.

Gets all categories available in the webstore.

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

Gets information about a specific category

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

Fetch a package from a webstore by its identifier

Fetch all packages from a webstore

Fetch a package from a webstore by its identifier

Fetch a package from a webstore by its identifier

Fetch a package from a webstore by its identifier

Remove a creator code from the basket.

Remove a coupon from the basket.

Fetch a webstore by its identifier

Create a new basket

Show child attributes

Apply a creator code to a basket.

Apply a gift card to a basket.

Remove a gift card from the basket.

Apply a coupon to a basket.

Add a package to a basket

Remove a package from a basket

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