Skip to content

Commit 13741fc

Browse files
authored
Update Product README
1 parent 6d2290d commit 13741fc

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,8 @@ Bigcommerce::deleteCartLineItem("xxxxxxxxx","xxxxxxxxx");
230230

231231
Products(V2 and V3)
232232
------------
233-
you can get products and its variants, options variant metafields.
233+
You can do all the functions of Products and More...
234+
234235
~~~php
235236
Bigcommerce::configure(array(
236237
'client_id' => 'xxxxxxxxxxxxxxxxxxxxxx',
@@ -269,27 +270,22 @@ $variant_metafield->delete();
269270
//or
270271
Bigcommerce::getProduct(1)->variants(123)->meta_fields(1)->delete();
271272
~~~
272-
The Product Instance has following member functions
273+
**The 'Product' Object has following member functions**
273274

275+
**Member Function works only on 'v3'**
276+
All the 'v3' Resource Class has `create(), update() and delete()` functions
274277
~~~php
275278
$product = Bigcommerce::getProduct(1);
276279

277-
/* Member Function works only on 'v3' */
278-
// All the 'v3' Resource Class has create(), update() and delete() functions
279-
280280

281281
// Delete bulk pricing id 1 for product id 1
282282
$product->bulk_pricing_rules(1)->delete();
283283

284284

285-
// 'ProductBulkPricingRule' Object has create(), update(), delete() functions
286-
287285
// Retrieve all Bulk Pricing rules for product id 1
288286
$bulk = $product->bulk_pricing_rules();
289287

290288

291-
// 'ProductComplexRule' Object has create(), update(), delete() functions
292-
293289
$complex_rules = $product->complex_rules();
294290
// or Bigcommerce::getProductComplexRules($product_id);
295291

@@ -319,9 +315,14 @@ $options = $product->options("v2");
319315
$option_values = $product->options("v3")->values();
320316
$option_value = $product->options("v3")->values(1);
321317
$option_value->delete();
318+
~~~
322319

320+
**Member Functions works on both 'v2' and 'v3'**
321+
Below are the function that works on both `v2` and `v3` versions
322+
you can override the default version by setting it in functions like: `Bigcommerce::getProduct(1)->brand("v3");`
323323

324-
/* Member Functions works on both 'v2' and 'v3' */
324+
~~~php
325+
$product = Bigcommerce::getProduct(1);
325326

326327
$brand = $product->brand();
327328

@@ -348,11 +349,12 @@ $custom_fields = $product->custom_fields();
348349

349350
$reviews = $product->reviews();
350351
// or Bigcommerce::getProductReviews($product_id);
352+
~~~
351353

352-
353-
/* Member Functions works only on 'v2' */
354-
// May return empty data since 'v2' has been abandoned by Bigcommerce
355-
354+
**Member Functions works only on 'v2'**
355+
Some functions may return empty data since 'v2' has been abandoned by Bigcommerce
356+
~~~php
357+
$product = Bigcommerce::getProduct(1);
356358

357359
$skus = $product->skus();
358360
$rules = $product->rules();

0 commit comments

Comments
 (0)