Download the PHP package yvz/bigcommerce-api-service without Composer
On this page you can find all versions of the php package yvz/bigcommerce-api-service. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yvz/bigcommerce-api-service
More information about yvz/bigcommerce-api-service
Files in yvz/bigcommerce-api-service
Package bigcommerce-api-service
Short Description BigCommerce API Service for Laravel applications
License MIT
Informations about the package bigcommerce-api-service
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
Install the package via Composer:
Usage
You can dynamically access all the available resources through the BigcommerceApiService
class. Example:
Available Resources and Methods
The following resources are available, each with its corresponding methods for interacting with the Bigcommerce API.
1. CategoryResource
Methods:
-
list(array $parameters, bool $includeHeaders = true): array
Retrieves a list of categories.- Example:
show(int $id, array $parameters = [], bool $includeHeaders = true): array
Retrieves details of a specific category.- Example:
2. BrandResource
Methods:
-
list(array $parameters, bool $includeHeaders = true): array
Retrieves a list of brands.- Example:
show(int $brandId, array $parameters = [], bool $includeHeaders = true): array
Retrieves details of a specific brand.- Example:
3. ProductResource
Methods:
-
list(array $parameters, bool $includeHeaders = true): array
Retrieves a list of products.- Example:
show(int $id, array $parameters = [], bool $includeHeaders = true): array
Retrieves details of a specific product.- Example:
4. ProductVariantResource
Methods:
-
list(int $productId, array $parameters, bool $includeHeaders = true): array
Retrieves a list of variants for a given product.- Example:
-
batchList(array $parameters, bool $includeHeaders = true): array
Retrieves a batch list of variants.- Example:
show(int $productId, int $variantId, array $parameters = [], bool $includeHeaders = true): array
Retrieves details of a specific variant.- Example:
5. ProductModifierResource
Methods:
-
list(int $productId, array $parameters, bool $includeHeaders = true): array
Retrieves the list of modifiers for a product.- Example:
show(int $productId, int $modifierId, array $parameters = [], bool $includeHeaders = true): array
Retrieves details of a specific modifier.- Example:
6. ProductCustomFieldResource
Methods:
-
list(int $productId, array $parameters, bool $includeHeaders = true): array
Retrieves the list of custom fields for a product.- Example:
show(int $productId, int $customFieldId, array $parameters = [], bool $includeHeaders = true): array
Retrieves details of a specific custom field.- Example:
7. ProductMetafieldResource
Methods:
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
Methods:
-
list(int $productId, int $variantId, array $parameters = [], bool $includeHeaders = true): array
Retrieves all metafields for a product variant.- Example:
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
All requests return a structured data array: