Creating a Basket

Depending on the type of Tebex store you are integrating, additional parameters may be necessary before the basket can be successfully created.

Authorizing Baskets

For most stores, the user must authorize their account before checkout is completed. This is done via the /auth endpoint where we will return the authentication options available for your store.

Provide a returnUrl , and after successful authentication the user will be directed back to your site.

Get authentication links for a basket.

Fetches a basket's auth URL.

get

/accounts/{token}/baskets/{basketIdent}/auth?returnUrl={returnUrl}

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

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

200

422

200

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

Successful response returns the basket auth information.

Minecraft and Overwolf Stores

You must provide the username parameter as part of the basket creation request so that the basket is attributed to the correct user:

If you are creating a basket on your backend server, you will need to provide us the ip_address of the customer.

Currently we are unable to support IPv6 addresses being provided in the ip_address property. While we work on enabling IPv6 support, please provide an IPv4 address for the customer.

If you are creating a basket from the user's browser, we will automatically determine the IP from the requesting device.

{
  "complete_url": "https://example.tebex.io/thank-you",
  "cancel_url": "https://tebex.io/",
  "custom": {
    "foo": "bar"
  },
  "complete_auto_redirect": true,
  "username": "TebexDev",
}

The Basket which is returned will include the username_id which may be required for certain endpoints.

You should save the username_id as part of the user's session for use later.

Universal Stores

No username is required, but depending on your package Deliverables you may need to provide variable_data so that the package is attributed to the correct user. See Adding Packages.

Create a new basket

Creates a new basket for use during checkout.

post

/accounts/{token}/baskets

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

Body

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/

complete_auto_redirectboolean

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

Example: true

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.

Example: {"foo":"bar"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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/","complete_auto_redirect":true,"custom":{"foo":"bar"}}'

200

422

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "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",
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    },
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    }
  }
}

Successful response returns the basket information.