Getting Your Listings
You can retrieve your packages & category listings in JSON format and display them however you wish.
Gets all categories from a webstore. This does not include package information. To include package information, add ?includePackages=1
to the URL.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
GET /api/accounts/{token}/categories HTTP/1.1
Host: headless.tebex.io
Accept: */*
Successful response returns a list of category information.
{
"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"
}
]
}
Gets all categories from a webstore including packages.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
GET /api/accounts/{token}/categories HTTP/1.1
Host: headless.tebex.io
Accept: */*
Successful response returns a list of category information.
{
"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"
}
]
}
Gets information about a category and returns the packages in that category.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The ID of the category to fetch.
127244343
GET /api/accounts/{token}/categories/{categoryId} HTTP/1.1
Host: headless.tebex.io
Accept: */*
Successful response returns the category without package information.
{
"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"
}
]
}
Gets information about a category and returns the packages in that category.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The ID of the category to fetch.
127244343
GET /api/accounts/{token}/categories/{categoryId} HTTP/1.1
Host: headless.tebex.io
Accept: */*
Successful response returns the category with package information.
{
"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"
}
]
}
Gets a package from a webstore by ID.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The package's ID.
1272441812
GET /api/accounts/{token}/packages/{packageId} HTTP/1.1
Host: headless.tebex.io
Accept: */*
Successful response returns the package information.
{
"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"
}
]
}
Gets all packages from a webstore.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
GET /api/accounts/{token}/packages HTTP/1.1
Host: headless.tebex.io
Accept: */*
Successful response returns a list of package information.
{
"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"
}
]
}
Authenticated Requests
Gets all packages from a webstore.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
An IP address can be provided with authenticated requests.
127.0.0.1
GET /api/accounts/{token}/packages HTTP/1.1
Host: headless.tebex.io
Accept: */*
{
"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"
}
]
}
Gets all packages from a webstore.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
An IP address can be provided with authenticated requests.
127.0.0.1
GET /api/accounts/{token}/packages HTTP/1.1
Host: headless.tebex.io
Accept: */*
{
"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"
}
]
}
Last updated
Was this helpful?