XStore Brands API

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 #

List Brands #

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

Definition  #

GET /wp/v2/etheme_brands

Example Request #

$ curl <a href="https://example.com/wp-json/wp/v2/etheme_brands">https://example.com/wp-json/wp/v2/etheme_brands</a>

Example URL #

Arguments  #

Create a Brand #

Definition #

POST /wp/v2/etheme_brands

Example Request from curl (in progress) #

$ curl <a href="https://example.com/wp-json/wp/v2/etheme_brands">https://example.com/wp-json/wp/v2/etheme_brands</a>

Example Request from wp #

$meta = (object) array(
	'some_meta' => 'value'
);
$image = array(
	'src'         => 'https://example.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg',
	'alt'         => 'some alt',
    'title'       => 'some title',
    'caption'     => 'some caption',
    'description' => 'some description'
);
$api_response = wp_remote_post( 'https://example.com/wp-json/wp/v2/etheme_brands', array(
	'headers' => array(
		'Authorization' => 'Basic ' . base64_encode( 'user_name:user_password' )
	),
	'body' => array(
		'name'        => 'example brand',
        'slug'        => 'example-brand',
        'description' => 'some description',
        'meta'        => $meta,
        'image'       => $image
	)
) );

Arguments #

$image = array(
	'src'         => 'https://example.com/wp-content/uploads/sites/56/2013/06/T_2_back.jpg',
	'alt'         => 'alt text',
	'title'       => 'title text',
	'caption'     => 'caption ',
	'description' => 'description'
);

Retrieve a Brand #

Definition & Example Request #

GET /wp/v2/etheme_brands/{brand_id}

Example Request #

$ 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>

Example URL #

Arguments  #

Update a Brand #

Definition #

POST /wp/v2/etheme_brands/id

Example Request from curl (in progress) #

$ curl <a href="https://example.com/wp-json/wp/v2/etheme_brands/id">https://example.com/wp-json/wp/v2/etheme_brands/id</a>

Example Request from WP #

$meta = (object) array(
	'some_meta' => 'value'
);

$image = array(
	'src'         => 'https://example.com/wp-content/uploads/sites/56/2013/06/T_2_back.jpg',
	'alt'         => 'some alt',
    'title'       => 'some title',
    'caption'     => 'some caption',
    'description' => 'some description'
);

$api_response = wp_remote_post( 'https://example.com/wp-json/wp/v2/etheme_brands/id', array(
	'headers' => array(
		'Authorization' => 'Basic ' . base64_encode( 'user_name:user_password' )
	),
	'body' => array(
		'name'        => 'new example brand',
        'slug'        => 'new-example-brand',
        'description' => 'new some description',
        'meta'        => $meta,
        'image'       => $image
	)
) );

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:

$meta = (object) array(
	'thumbnail_id' => 5054, // ID of image in media library
);

Arguments  #

Delete a Brand #

Definition  #

POST DELETE /wp/v2/etheme_brands/id

Example Request #

$ curl -X  DELETEhttps://example.com/wp-json/wp/v2/etheme_brands/id

Example Request from WP #

$api_response = wp_remote_post( 'https://example.com/wp-json/wp/v2/etheme_brands/id', array(
	'method'    => 'DELETE',
	'headers' => array(
		'Authorization' => 'Basic ' . base64_encode( 'user_name:user_password' )
	),
	'body' => array(
        'force' => true,
	)
) );

or

$api_response = wp_remote_post( 'https://example.com/wp-json/wp/v2/etheme_brands/id?force=true', array(
	'method'    => 'DELETE',
	'headers' => array(
		'Authorization' => 'Basic ' . base64_encode( 'user_name:user_password' )
	),
) );

Arguments  #

To setup product brands for products, you can use the default WooCommerce Rest API and add to request etheme_brands param: etheme_brands (array)

For example when creating the product

$api_response = wp_remote_post( 'https://example.com/wp-json/wc/v3/products/', array(
			'method'    => 'POST',
			'headers' => array(
				'Authorization' => 'Basic ' . base64_encode( 'consumer_key:consumer_secret' )
			),
			'body' => array(
				'name' => 'Premium Quality aaaaaaaaa',
				"regular_price" => "21.99",
		        "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.",
		        "short_description" => "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
				'etheme_brands' => array(45,48),
				"images" => array(array("src"=> "https://example.com/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"),
		        ),
			)
		) );

For example when updating the product

$api_response = wp_remote_post( 'https://example.com/wp-json/wc/v3/products/4953', array(
		'method'    => 'POST',
		'headers' => array(
			'Authorization' => 'Basic ' . base64_encode( 'consumer_key:consumer_secret' )
		),
		'body' => array(
	        "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.",
			'etheme_brands' => array(45,48),
		)
	) );