{"id":1779,"date":"2024-09-26T13:44:50","date_gmt":"2024-09-26T13:44:50","guid":{"rendered":"http:\/\/docs"},"modified":"2024-09-26T13:44:50","modified_gmt":"2024-09-26T13:44:50","password":"","slug":"xstore-brands-api","status":"publish","type":"docs","link":"https:\/\/www.8theme.com\/documentation\/xstore\/xstore-hooks-filters\/xstore-brands-api\/","title":{"rendered":"XStore Brands API"},"content":{"rendered":"

Brands (eteheme_brands)<\/h3>\n

The schema defines all the fields that exist within a brand record. Any response from these endpoints can be expected to contain the fields below unless the _filter<\/code> query parameter is used or the schema field only appears in a specific context.<\/p>\n

Schema<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n
\n\t\tid<\/strong>
\n\t\t(integer)\n\t<\/td>\n		\n\t\tUnique identifier for the term.
\n\t\t
\n\t\tRead-only
\n\t\t
\n\t\tContext:
\n\t\tview, embed, edit<\/strong>\n\t<\/td>\n<\/tr>\n
\n\t\tcount<\/strong>
\n\t\t(integer)\n\t<\/td>\n		\n\t\tThe number of published posts for the term.
\n\t\t
\n\t\tRead-only
\n\t\t
\n\t\tContext:
\n\t\tview, edit<\/strong>\n\t<\/td>\n<\/tr>\n
\n\t\tdescription<\/strong>
\n\t\t(string)\n\t<\/td>\n		\n\t\tHTML description of the term.
\n\t\t
\n\t\tContext:
\n\t\tview, edit<\/strong>\n\t<\/td>\n<\/tr>\n
\n\t\tlink<\/strong>
\n\t\t(string, URI)\n\t<\/td>\n		\n\t\tURL of the term.
\n\t\t
\n\t\tRead-only
\n\t\t
\n\t\tContext:
\n\t\tview, embed, edit<\/strong>\n\t<\/td>\n<\/tr>\n
\n\t\tname<\/strong>
\n\t\t(string) \n\t<\/td>\n		\n\t\tHTML title for the term.
\n\t\t
\n\t\tContext:
\n\t\tview, embed, edit<\/strong>\n\t<\/td>\n<\/tr>\n
\n\t\tslug<\/strong>
\n\t\t(string) \n\t<\/td>\n		\n\t\tAn alphanumeric identifier for the term unique to its type.
\n\t\t
\n\t\tContext:
\n\t\tview, embed, edit<\/strong>\n\t<\/td>\n<\/tr>\n
\n\t\ttaxonomy<\/strong>
\n\t\t(string)\n\t<\/td>\n		\n\t\tType attribution for the term.
\n\t\t
\n\t\tRead-only
\n\t\t
\n\t\tContext:
\n\t\tview, embed, edit<\/strong>
\n\t\tOne of: category, post_tag, nav_menu, link_category, post_format
\n\t\t\n\t<\/td>\n<\/tr>\n
\n\t\tparent<\/strong>
\n\t\t(integer)\n\t<\/td>\n		\n\t\tThe parent term ID.
\n\t\t
\n\t\tContext:
\n\t\tview, edit<\/strong>\n\t<\/td>\n<\/tr>\n
\n\t\tmeta<\/strong>
\n\t\t(object, array)\n\t<\/td>\n		\n\t\tMeta fields.
\n\t\t
\n\t\tContext:
\n\t\tview, edit<\/strong>\n\t<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

List Brands<\/h3>\n

Query this endpoint to retrieve a collection of brands. The response you receive can be controlled and filtered using the URL query parameters below.<\/p>\n

Definition\u00a0<\/h4>\n
GET \/wp\/v2\/etheme_brands\n<\/pre>\n
Example Request<\/h4>\n
$ curl <a href="https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands">https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands<\/a>\n<\/pre>\n
Example URL<\/h4>\n
https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands<\/code><\/div>\n
Arguments\u00a0<\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
context<\/strong><\/td>\n\n
The scope under which the request is made; determines the fields present in the response.<\/p>\n
Default: view<\/p>\n
One of: view, embed, edit<\/strong><\/p>\n<\/td>\n<\/tr>\n
page<\/strong><\/td>\n\n
Current page of the collection.<\/p>\n
Default: 1<\/strong><\/p>\n<\/td>\n<\/tr>\n
per_page<\/strong><\/td>\n\n
Maximum number of items to be returned in result set.<\/p>\n
Default: 10<\/strong><\/p>\n<\/td>\n<\/tr>\n
search<\/strong><\/td>\nLimit results to those matching a string.<\/td>\n<\/tr>\n
exclude<\/strong><\/td>\nEnsure the result set excludes specific IDs.<\/td>\n<\/tr>\n
include<\/strong><\/td>\nLimit result set to specific IDs.<\/td>\n<\/tr>\n
order<\/strong><\/td>\n\n
Order sort attribute ascending or descending.<\/p>\n
Default: asc<\/strong><\/p>\n
One of: asc, desc<\/strong><\/p>\n<\/td>\n<\/tr>\n
orderby<\/strong><\/td>\n\n
Sort collection by term attribute.<\/p>\n
Default: name<\/strong><\/p>\n
One of: id, include, name, slug, include_slugs, term_group, description, count<\/strong><\/p>\n<\/td>\n<\/tr>\n
hide_empty<\/strong><\/td>\nWhether to hide terms not assigned to any posts.<\/td>\n<\/tr>\n
parent<\/strong><\/td>\nLimit result set to terms assigned to a specific parent.<\/td>\n<\/tr>\n
post<\/strong><\/td>\nLimit results set to terms assigned to a specific post.<\/td>\n<\/tr>\n
slug<\/strong><\/td>\nLimit results set to terms with one or more specific slugs.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Create a Brand<\/h3>\n
Definition<\/h4>\n
POST \/wp\/v2\/etheme_brands\n<\/pre>\n
Example Request from curl (in progress)<\/h4>\n
$ curl <a href="https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands">https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands<\/a>\n<\/pre>\n
Example Request from wp<\/h4>\n
$meta = (object) array(\n\t'some_meta' => 'value'\n);\n$image = array(\n\t'src'         => 'https:\/\/example.com\/woocommerce\/wp-content\/uploads\/sites\/56\/2013\/06\/T_2_back.jpg',\n\t'alt'         => 'some alt',\n    'title'       => 'some title',\n    'caption'     => 'some caption',\n    'description' => 'some description'\n);\n$api_response = wp_remote_post( 'https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands', array(\n\t'headers' => array(\n\t\t'Authorization' => 'Basic ' . base64_encode( 'user_name:user_password' )\n\t),\n\t'body' => array(\n\t\t'name'        => 'example brand',\n        'slug'        => 'example-brand',\n        'description' => 'some description',\n        'meta'        => $meta,\n        'image'       => $image\n\t)\n) );\n<\/pre>\n
Arguments<\/h3>\n\n\n\n\n\n\n\n\n
\n
description<\/strong><\/p>\n
(string)<\/p>\n<\/td>\n
HTML description of the Brand.<\/td>\n<\/tr>\n
\n
name<\/strong> <\/p>\n
(string)<\/p>\n<\/td>\n
\n
HTML title for the term.<\/p>\n
Required: 1(true)<\/p>\n<\/td>\n<\/tr>\n
\n
slug<\/strong> <\/p>\n
(string)<\/p>\n<\/td>\n
An alphanumeric identifier for the term unique to its type.<\/td>\n<\/tr>\n
\n
parent<\/strong> <\/p>\n
(integer)<\/p>\n<\/td>\n
The parent term ID.<\/td>\n<\/tr>\n
\n
meta<\/strong> <\/p>\n
(array, object)<\/p>\n<\/td>\n
Meta fields.<\/td>\n<\/tr>\n
\n
image<\/strong> <\/p>\n
(array, object)<\/p>\n<\/td>\n
\n
image data for brand<\/p>\n
src<\/strong> (string); Required: 1(true)<\/p>\n
alt<\/strong> (string)<\/p>\n
title<\/strong> (string)<\/p>\n
caption<\/strong> (string)<\/p>\n
description<\/strong> (string)<\/p>\n
Example array:<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
$image = array(\n\t'src'         => 'https:\/\/example.com\/wp-content\/uploads\/sites\/56\/2013\/06\/T_2_back.jpg',\n\t'alt'         => 'alt text',\n\t'title'       => 'title text',\n\t'caption'     => 'caption ',\n\t'description' => 'description'\n);\n<\/pre>\n
Retrieve a Brand<\/h3>\n
Definition & Example Request<\/h4>\n
GET \/wp\/v2\/etheme_brands\/{brand_id}\n<\/pre>\n
Example Request<\/h4>\n
$ curl <a href="https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands{brand_id}">https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands{brand_id}<\/a>\n<\/pre>\n
Example URL<\/h4>\n
https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands{brand_id}<\/code><\/div>\n
Arguments\u00a0<\/h3>\n\n\n\n\n
id<\/strong><\/td>\nUnique identifier for the term.<\/td>\n<\/tr>\n
context<\/strong><\/td>\n\n
Scope under which the request is made; determines the fields present in the response.<\/p>\n
Default: view<\/strong><\/p>\n
One of: view, embed, edit<\/strong><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Update a Brand<\/h3>\n
Definition<\/h4>\n
POST \/wp\/v2\/etheme_brands\/id\n<\/pre>\n
Example Request from curl (in progress)<\/h4>\n
$ curl <a href="https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands\/id">https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands\/id<\/a>\n<\/pre>\n
Example Request from WP<\/h4>\n
$meta = (object) array(\n\t'some_meta' => 'value'\n);\n\n$image = array(\n\t'src'         => 'https:\/\/example.com\/wp-content\/uploads\/sites\/56\/2013\/06\/T_2_back.jpg',\n\t'alt'         => 'some alt',\n    'title'       => 'some title',\n    'caption'     => 'some caption',\n    'description' => 'some description'\n);\n\n$api_response = wp_remote_post( 'https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands\/id', array(\n\t'headers' => array(\n\t\t'Authorization' => 'Basic ' . base64_encode( 'user_name:user_password' )\n\t),\n\t'body' => array(\n\t\t'name'        => 'new example brand',\n        'slug'        => 'new-example-brand',\n        'description' => 'new some description',\n        'meta'        => $meta,\n        'image'       => $image\n\t)\n) );\n<\/pre>\n
To prevent uploading and setup the same image just remove the image param. If you want to change the image that already exists modify mata param:<\/p>\n
$meta = (object) array(\n\t'thumbnail_id' => 5054, \/\/ ID of image in media library\n);\n<\/pre>\n
Arguments\u00a0<\/h3>\n\n\n\n\n\n\n\n\n
id<\/strong><\/td>\nUnique identifier for the term.<\/td>\n<\/tr>\n
description<\/strong><\/td>\nHTML description of the term.<\/td>\n<\/tr>\n
name<\/strong><\/td>\nHTML title for the term.<\/td>\n<\/tr>\n
slug<\/strong><\/td>\nAn alphanumeric identifier for the term unique to its type.<\/td>\n<\/tr>\n
parent<\/strong><\/td>\nThe parent term ID.<\/td>\n<\/tr>\n
meta<\/strong><\/td>\nMeta fields.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Delete a Brand<\/h3>\n
Definition\u00a0<\/h4>\n
POST DELETE \/wp\/v2\/etheme_brands\/id\n<\/pre>\n
Example Request<\/h4>\n
$ curl -X\u00a0 DELETEhttps:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands\/id\n<\/pre>\n
Example Request from WP<\/h4>\n
$api_response = wp_remote_post( 'https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands\/id', array(\n\t'method'    => 'DELETE',\n\t'headers' => array(\n\t\t'Authorization' => 'Basic ' . base64_encode( 'user_name:user_password' )\n\t),\n\t'body' => array(\n        'force' => true,\n\t)\n) );\n<\/pre>\n
or<\/p>\n
$api_response = wp_remote_post( 'https:\/\/example.com\/wp-json\/wp\/v2\/etheme_brands\/id?force=true', array(\n\t'method'    => 'DELETE',\n\t'headers' => array(\n\t\t'Authorization' => 'Basic ' . base64_encode( 'user_name:user_password' )\n\t),\n) );\n<\/pre>\n
Arguments\u00a0<\/h4>\n\n\n\n\n
id<\/strong><\/td>\nUnique identifier for the term.<\/td>\n<\/tr>\n
force<\/strong><\/td>\nRequired to be true, Brands do not support trashing.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
To setup product brands for products, you can use the default WooCommerce Rest API<\/a> and add to request etheme_brands<\/code> param: etheme_brands (array)<\/strong><\/p>\n
For example when creating the product<\/p>\n
$api_response = wp_remote_post( 'https:\/\/example.com\/wp-json\/wc\/v3\/products\/', array(\n\t\t\t'method'    => 'POST',\n\t\t\t'headers' => array(\n\t\t\t\t'Authorization' => 'Basic ' . base64_encode( 'consumer_key:consumer_secret' )\n\t\t\t),\n\t\t\t'body' => array(\n\t\t\t\t'name' => 'Premium Quality aaaaaaaaa',\n\t\t\t\t"regular_price" => "21.99",\n\t\t        "description" => "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",\n\t\t        "short_description" => "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",\n\t\t\t\t'etheme_brands' => array(45,48),\n\t\t\t\t"images" => array(array("src"=> "https:\/\/example.com\/wp-content\/uploads\/sites\/56\/2013\/06\/T_2_front.jpg"),\n\t\t        ),\n\t\t\t)\n\t\t) );\n<\/pre>\n
For example when updating the product<\/p>\n
$api_response = wp_remote_post( 'https:\/\/example.com\/wp-json\/wc\/v3\/products\/4953', array(\n\t\t'method'    => 'POST',\n\t\t'headers' => array(\n\t\t\t'Authorization' => 'Basic ' . base64_encode( 'consumer_key:consumer_secret' )\n\t\t),\n\t\t'body' => array(\n\t        "description" => "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",\n\t\t\t'etheme_brands' => array(45,48),\n\t\t)\n\t) );\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
Brands (eteheme_brands) The schema defines all the fields that exist within a brand record. Any response from these endpoints can be expected to contain the fields below unless the _filter query parameter is used or the schema field only appears in a specific context. Schema id (integer) Unique identifier for the term. Read-only Context: view, […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"doc_category":[48],"doc_tag":[],"class_list":["post-1779","docs","type-docs","status-publish","hentry","doc_category-xstore-hooks-filters"],"aioseo_notices":[],"year_month":"2026-07","word_count":1214,"total_views":"5621","reactions":{"happy":"0","normal":"0","sad":"0"},"author_info":{"author_nicename":"docs","author_url":"https:\/\/www.8theme.com\/documentation\/author\/docs\/"},"doc_category_info":[{"term_name":"XStore Hooks & Filters","term_url":"https:\/\/www.8theme.com\/documentation\/xstore\/xstore-hooks-filters\/"}],"doc_tag_info":[],"author_list":[{"ID":"1","user_login":"docs","display_name":"docs","id":"1"}],"knowledge_base_info":[],"knowledge_base_slug":[],"_links":{"self":[{"href":"https:\/\/www.8theme.com\/documentation\/wp-json\/wp\/v2\/docs\/1779","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.8theme.com\/documentation\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.8theme.com\/documentation\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.8theme.com\/documentation\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.8theme.com\/documentation\/wp-json\/wp\/v2\/comments?post=1779"}],"version-history":[{"count":0,"href":"https:\/\/www.8theme.com\/documentation\/wp-json\/wp\/v2\/docs\/1779\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.8theme.com\/documentation\/wp-json\/wp\/v2\/media?parent=1779"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.8theme.com\/documentation\/wp-json\/wp\/v2\/doc_category?post=1779"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.8theme.com\/documentation\/wp-json\/wp\/v2\/doc_tag?post=1779"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}