1 of 1

Directing to Checkout

When the user is ready to checkout, you can fetch the current basket and direct the user to its links.checkout URL. Here, the user will enter their payment information and complete checkout.

If you'd like the user to stay on your site during checkout, use Tebex.js alongside the Headless API.

For most stores, authorizing the user against the basket is required before checkout. You can do this by directing the user to the appropriate link provided by the /baskets/auth endpoint. Read more here.

Directing to Checkout

When the user is ready to checkout, you can fetch the current basket and direct the user to its links.checkout URL. Here, the user will enter their payment information and complete checkout.

If you'd like the user to stay on your site during checkout, use Tebex.js alongside the Headless API.

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

Successful response returns the basket information.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

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)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

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

Successful response returns the basket information.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

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)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

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

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