PHPackages                             yvz/bigcommerce-api-service - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. yvz/bigcommerce-api-service

ActiveLibrary[API Development](/categories/api)

yvz/bigcommerce-api-service
===========================

BigCommerce API Service for Laravel applications

1.0.0(1y ago)03MITPHPPHP ^8.0

Since Jan 20Pushed 1y ago1 watchersCompare

[ Source](https://github.com/altugyavuz/bigcommerce-api-service)[ Packagist](https://packagist.org/packages/yvz/bigcommerce-api-service)[ RSS](/packages/yvz-bigcommerce-api-service/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)DependenciesVersions (2)Used By (0)

Bigcommerce API Service - Lite
==============================

[](#bigcommerce-api-service---lite)

The **`Bigcommerce API Service`** package allows you to interact with Bigcommerce's API for managing catalog resources such as products, categories, brands, variants, custom fields, and more. This package for multi-tenant systems.

---

Installation
------------

[](#installation)

Install the package via Composer:

```
composer require yvz/bigcommerce-api-service
```

---

Usage
-----

[](#usage)

You can dynamically access all the available resources through the `BigcommerceApiService` class. Example:

```
use Yvz\BigcommerceApiService\Services\BigcommerceApiService;

$service = new BigcommerceApiService('storeHash', 'accessToken');

// Example: Fetch product list
$products = $service->products->list(['limit' => 10]);
```

---

Available Resources and Methods
-------------------------------

[](#available-resources-and-methods)

The following resources are available, each with its corresponding methods for interacting with the Bigcommerce API.

---

### **1. CategoryResource**

[](#1-categoryresource)

#### Methods:

[](#methods)

- **`list(array $parameters, bool $includeHeaders = true): array`**
    Retrieves a list of categories.

    - **Example:**```
        $categories = $service->categories->list(['limit' => 10]);
        ```
- **`show(int $id, array $parameters = [], bool $includeHeaders = true): array`**
    Retrieves details of a specific category.

    - **Example:**```
        $category = $service->categories->show(123);
        ```

---

### **2. BrandResource**

[](#2-brandresource)

#### Methods:

[](#methods-1)

- **`list(array $parameters, bool $includeHeaders = true): array`**
    Retrieves a list of brands.

    - **Example:**```
        $brands = $service->brands->list(['limit' => 5]);
        ```
- **`show(int $brandId, array $parameters = [], bool $includeHeaders = true): array`**
    Retrieves details of a specific brand.

    - **Example:**```
        $brand = $service->brands->show(45);
        ```

---

### **3. ProductResource**

[](#3-productresource)

#### Methods:

[](#methods-2)

- **`list(array $parameters, bool $includeHeaders = true): array`**
    Retrieves a list of products.

    - **Example:**```
        $products = $service->products->list(['limit' => 20]);
        ```
- **`show(int $id, array $parameters = [], bool $includeHeaders = true): array`**
    Retrieves details of a specific product.

    - **Example:**```
        $product = $service->products->show(567);
        ```

---

### **4. ProductVariantResource**

[](#4-productvariantresource)

#### Methods:

[](#methods-3)

- **`list(int $productId, array $parameters, bool $includeHeaders = true): array`**
    Retrieves a list of variants for a given product.

    - **Example:**```
        $variants = $service->variants->list(1234, []);
        ```
- **`batchList(array $parameters, bool $includeHeaders = true): array`**
    Retrieves a batch list of variants.

    - **Example:**```
        $batchVariants = $service->variants->batchList([]);
        ```
- **`show(int $productId, int $variantId, array $parameters = [], bool $includeHeaders = true): array`**
    Retrieves details of a specific variant.

    - **Example:**```
        $variant = $service->variants->show(1234, 5678);
        ```

---

### **5. ProductModifierResource**

[](#5-productmodifierresource)

#### Methods:

[](#methods-4)

- **`list(int $productId, array $parameters, bool $includeHeaders = true): array`**
    Retrieves the list of modifiers for a product.

    - **Example:**```
        $modifiers = $service->modifiers->list(1234, []);
        ```
- **`show(int $productId, int $modifierId, array $parameters = [], bool $includeHeaders = true): array`**
    Retrieves details of a specific modifier.

    - **Example:**```
        $modifier = $service->modifiers->show(1234, 4321);
        ```

---

### **6. ProductCustomFieldResource**

[](#6-productcustomfieldresource)

#### Methods:

[](#methods-5)

- **`list(int $productId, array $parameters, bool $includeHeaders = true): array`**
    Retrieves the list of custom fields for a product.

    - **Example:**```
        $customFields = $service->customFields->list(1234, []);
        ```
- **`show(int $productId, int $customFieldId, array $parameters = [], bool $includeHeaders = true): array`**
    Retrieves details of a specific custom field.

    - **Example:**```
        $customField = $service->customFields->show(1234, 5678);
        ```

---

### **7. ProductMetafieldResource**

[](#7-productmetafieldresource)

#### Methods:

[](#methods-6)

- **`list(int $productId, array $parameters = [], bool $includeHeaders = true): array`**
    Retrieves all metafields for a product.
- **`batchList(array $parameters = [], bool $includeHeaders = true): array`**
    Retrieves a batch list of metafields.
- **`create(int $productId, array $parameters = [], bool $includeHeaders = true): array`**
    Creates a metafield for a product.
- **`update(int $productId, int $metafieldId, array $parameters = [], bool $includeHeaders = true): array`**
    Updates a metafield for a product.
- **`delete(int $productId, int $metafieldId, bool $includeHeaders = true): array`**
    Deletes a metafield for a product.

---

### **8. ProductVariantMetafieldResource**

[](#8-productvariantmetafieldresource)

#### Methods:

[](#methods-7)

- **`list(int $productId, int $variantId, array $parameters = [], bool $includeHeaders = true): array`**
    Retrieves all metafields for a product variant.

    - **Example:**```
        $metafields = $service->variantMetafields->list(1234, 5678, []);
        ```
- **`batchList(array $parameters = [], bool $includeHeaders = true): array`**
    Retrieves a batch list of metafields.
- **`show(int $productId, int $variantId, int $metafieldId, array $parameters = [], bool $includeHeaders = true): array`**
    Retrieves details of a specific metafield.
- **`create(int $productId, int $variantId, array $parameters = [], bool $includeHeaders = true): array`**
    Creates a new metafield for a variant.
- **`update(int $productId, int $variantId, int $metafieldId, array $parameters = [], bool $includeHeaders = true): array`**
    Updates an existing metafield for a variant.
- **`delete(int $productId, int $variantId, int $metafieldId, bool $includeHeaders = true): array`**
    Deletes a metafield for a variant.

---

Response Format
---------------

[](#response-format)

All requests return a structured data array:

### Success:

[](#success)

```
[
    'status' => true,        // true if request was successful
    'statusCode' => 200,     // HTTP response code
    'data' => [...],         // Response data
    'headers' => [...]       // Headers in the response
]
```

### Error:

[](#error)

```
[
    'status' => false,
    'statusCode' => 400,
    'error_bag' => 'Error message...',
    'headers' => [...]
]
```

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance42

Moderate activity, may be stable

Popularity3

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

483d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c6c4dafd83786a165f7a5d757ff2400894cb3d4a1657ba89fc7c3e65d70b8c99?d=identicon)[yvz](/maintainers/yvz)

### Embed Badge

![Health badge](/badges/yvz-bigcommerce-api-service/health.svg)

```
[![Health](https://phpackages.com/badges/yvz-bigcommerce-api-service/health.svg)](https://phpackages.com/packages/yvz-bigcommerce-api-service)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)