bigc
An unofficial Python client for the BigCommerce API.
Installation
pip install bigc
Usage
To authenticate, you'll need the BigCommerce store's hash and an access token.
from bigc import BigCommerceAPI
store_hash = '000000000'
access_token = '0000000000000000000000000000000'
bigcommerce = BigCommerceAPI(store_hash, access_token)
order = bigcommerce.orders_v2.get(101)
list_of_orders = list(bigcommerce.orders_v2.all(params={'customer_id': 1}))
The following resources are currently supported:
carts_v3categories_v3checkouts_v3currencies_v2customers_v3customer_groups_v2orders_v2orders_v3pricing_v3products_v3product_variants_v3webhooks_v3
Exceptions
If a request is not successful, bigc will raise an exception inheriting from BigCommerceException. The full exception hierarchy is available in bigc.exceptions. Most exceptions correspond to a specific status code (e.g. DoesNotExistError will be raised for 404s).
If BigCommerce provides an error message in its response, it will be available as exc.message. More detailed error information may be available as exc.errors.
Timeouts
A timeout may be set on individual requests, or a default may be set for all requests. This specifies the maximum amount of time, in seconds, that may pass between receiving data from the server.
If a request times out, a GatewayTimeoutError will be raised.
from bigc import BigCommerceAPI
bigcommerce = BigCommerceAPI('store_hash', 'access_token', timeout=7)
bigcommerce.checkouts_v3.create_order('checkout_id', timeout=16)
Automatic Retries
bigc can automatically retry requests that fail due to network problems or certain types of server errors. You can specify the maximum number of retries as a default for all GET requests, or on a per-request basis.
from bigc import BigCommerceAPI
bigcommerce = BigCommerceAPI('store_hash', 'access_token', get_retries=2)
bigcommerce.customers_v3.get(1, retries=5)
Connection Pooling
Connections are pooled and reused instead of reopened for each request. This needs no setup, and applies across both the v2 and v3 APIs.
The pool belongs to the BigCommerceAPI instance, so reuse a single instance rather than creating one per request. Instances are safe to share between threads, and each thread gets its own pool.
Direct API Access
For resources that aren't officially supported yet, bigc also includes a flexible API client that can be used to make direct requests to the BigCommerce API.
from bigc import BigCommerceAPI
bigcommerce = BigCommerceAPI('store_hash', 'access_token')
product = bigcommerce.api_v3.get('/products/77', params={'include': 'videos'})
order_messages = list(bigcommerce.api_v2.get_many('/orders/101/messages'))
Utilities
Some extra utility functions that don't interact with the BigCommerce API are available in bigc.utils.
bigc.utils.parse_rfc2822_date: Convert an RFC-2822 date (used by some BigCommerce APIs) to adatetime
Constants
For convenience, some constants are made available in bigc.data.
bigc.data.BigCommerceOrderStatus: AnIntEnumof order statuses and their IDs
Development
This project uses uv for dependency management and packaging.
Setup
- Install uv
- Run
uv syncto install dependencies and set up a virtual environment
Running Tests
uv run pytest
1 maintainer
Metadata
1 maintainer
Release files for bigc 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| bigc-1.1.0.tar.gz | 11.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bigc-1.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 31.2 kB
Release files / bigc-1.1.0.tar.gz
| Download URL | bigc-1.1.0.tar.gz |
|---|---|
| Size | 11.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
de7951f26d3db274e42df825c1cfc7b3bc485c2a65892930617cb27057072078
|
|
BLAKE2b-256 checksum How to use checksums |
50281ddf51a83158fbb2bb756e2faff9e74d56673a890a31ac8c11bbaed8e909
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / bigc-1.1.0-py3-none-any.whl
| Download URL | bigc-1.1.0-py3-none-any.whl |
|---|---|
| Size | 19.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ca53b53e2493bb7500c8ef8b1621f2898465b174ab4e75f0bfb50e0c7b7a0de7
|
|
BLAKE2b-256 checksum How to use checksums |
df089f868f5d3d693dd2d424cb92d43db6ce200970d2bda965e0ac3285e55d6c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for bigc 1.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
