Skip to main content

Unofficial client for the BigCommerce API

Project description

bigc

An unofficial Python client for the BigCommerce API.

This project is currently in an alpha state.

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: dict = bigcommerce.orders.get(101)
orders: list[dict] = list(bigcommerce.orders.all(customer_id=1))

The following resources are currently supported:

  • carts
  • customers
  • orders
  • products
  • product_variants
  • webhooks

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 a datetime

Constants

For convenience, some constants are made available in bigc.data.

  • bigc.data.BigCommerceOrderStatus: An Enum of order statuses and their IDs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bigc-0.1.3.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bigc-0.1.3-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file bigc-0.1.3.tar.gz.

File metadata

  • Download URL: bigc-0.1.3.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.12 Linux/5.13.0-1022-azure

File hashes

Hashes for bigc-0.1.3.tar.gz
Algorithm Hash digest
SHA256 1750bcc75cc5ee317b53be687bc42164ec5aaa6e5be5de9cecbfa6de2964a04d
MD5 ccb2ae749f5003f7326f44ae7b9e7625
BLAKE2b-256 f221e93a802819beb3f3259dd39259e9105c4ba71d46dc1a484087f6e244ce51

See more details on using hashes here.

File details

Details for the file bigc-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: bigc-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.12 Linux/5.13.0-1022-azure

File hashes

Hashes for bigc-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7258f3347499097452e04737fc2b307284248e28d40ad8e746cf2801713dfdf8
MD5 a6e6be98ce1a5a652f9f997ed397fac4
BLAKE2b-256 517a4a223dc4f983a6c6900f042f495213263d3a6887c14174d8dbb87e3349ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page