using-b2c-tooling-sdk

Using the B2C Tooling SDK (Python)

salesforce-b2c-tooling-sdk is the Python SDK for Salesforce B2C Commerce tooling. Import name is b2c_tooling_sdk; distribution name is salesforce-b2c-tooling-sdk. It is async-first with a complete synchronous facade. Python 3.10+.

This skill covers consuming the SDK. For developing the SDK itself, see python/b2c-tooling-sdk/CLAUDE.md. For the full symbol catalog, read references/api-catalog.md.

1. Install

Not on PyPI yet — install from git during development:

pip install "git+https://github.com/SalesforceCommerceCloud/b2c-developer-tooling.git@main#subdirectory=python/b2c-tooling-sdk"
# or pin a release tag: ...@<tag>#subdirectory=python/b2c-tooling-sdk

For notebooks also install a kernel: pip install ipykernel. Once published this becomes pip install salesforce-b2c-tooling-sdk.

2. Async vs. sync — pick the import root

The two surfaces are identical except one word: sync drops await.

Context	Import from	Style
Scripts / notebooks / REPL	b2c_tooling_sdk.sync	blocking, no await
Inside an existing event loop (web server, async app)	b2c_tooling_sdk	await

Notebooks: use the sync facade — it is the frictionless path (no asyncio.run, no await). All sync calls run on one shared background loop, so token caching still works.

# Notebook / script (sync)
from b2c_tooling_sdk.sync import resolve_config
from b2c_tooling_sdk.sync import list_code_versions

config = resolve_config()                       # blocks
instance = config.create_b2c_instance()
for v in list_code_versions(instance):
    print(v.id, "active" if v.active else "")

# Async
import asyncio
from b2c_tooling_sdk import resolve_config
from b2c_tooling_sdk.operations.code import list_code_versions

async def main() -> None:
    config = await resolve_config()
    instance = config.create_b2c_instance()
    for v in await list_code_versions(instance):
        print(v.id)

asyncio.run(main())