BEEP! Python SDK
Official Python SDK for the BEEP! Developer API.
Installation
pip install beep-sdk
# or copy this package into your project
Quick Start
from beep import BeepClient
# Use your Secret Key (bk_test_sk_... for sandbox, bk_live_sk_... for production)
client = BeepClient("bk_test_sk_YOUR_SECRET_KEY")
# List stores
stores = client.stores.list()
# Insert a product
product = client.catalog.insert_product(
storeId="your_store_id",
ean="4000000000001",
name="Bio-Vollmilch 3,5%",
brand="BioHof",
price=1.49,
vat=7,
)
Available Resources
| Resource | Methods | Min. Package |
|---|---|---|
client.stores |
list(), get(), register() |
DISCOVER |
client.catalog |
insert_product(), list_products(), get_product(), register_to_store(), bulk_import() |
DISCOVER |
client.offers |
create(), update(), delete(), list() |
GO |
client.click_collect |
submit_order(), update_status() |
GO |
client.loyalty |
create_program(), enroll(), add_points(), redeem_points(), get_customer_balance(), get_analytics(), sync_external() |
GO |
client.scan_and_go |
check_in(), start_checkout(), get_purchase(), get_purchase_history(), generate_receipt(), get_receipt_from_token(), get_recommendations(), configure_recommendations() |
GROW |
client.integrations |
sync_pos(), push_to_pos(), sync_erp(), push_to_erp(), configure_psp(), process_payment(), refund_payment() |
GROW |
client.analytics |
get(), export_sales(), export_receipts() |
GO / GROW |
Error Handling
from beep import BeepClient, AuthenticationError, BeepPermissionError, RateLimitError
try:
result = client.scan_and_go.check_in(storeId="store_001")
except AuthenticationError:
print("Invalid API key")
except BeepPermissionError as e:
print(f"Upgrade required: {e.details.get('requiredUpgrade')}")
except RateLimitError as e:
print(f"Rate limited. Retry after {e.retry_after}s")
Documentation
1 maintainer
Metadata
1 maintainer
Release files for beep-sdk 1.0.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 | |
|---|---|---|---|
| beep_sdk-1.0.0.tar.gz | 5.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| beep_sdk-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.0 kB
Release files / beep_sdk-1.0.0.tar.gz
| Download URL | beep_sdk-1.0.0.tar.gz |
|---|---|
| Size | 5.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f6cd97763901ac5233fd8ee965029f9010cd823af0ee3efcfa4ac4bb13922d38
|
|
BLAKE2b-256 checksum How to use checksums |
9325c7acab1496a3a6f879576444860feb1c3034a95732601c4845a123d0673a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|
Release files / beep_sdk-1.0.0-py3-none-any.whl
| Download URL | beep_sdk-1.0.0-py3-none-any.whl |
|---|---|
| Size | 6.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
80f9beca32661bc2675c87ed155598cd25515c1113bf1550f8af3af2d77fcf57
|
|
BLAKE2b-256 checksum How to use checksums |
88c09226bb9dfea18fd96f2c2e6054a55f1a34068bb1f86a1f18aca37b460ecc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|
