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.

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