omnicommerce

Python client for the OmniCommerce API.

The client is generated from the public OpenAPI spec, the same operation map as @omni-commerce/sdk. Sync and async clients take snake_case keyword arguments. Responses are parsed JSON.

Install

Install from PyPI:

python3 -m pip install omnicommerce

Python 3.10+.

Usage

import os
from omnicommerce import Omni

with Omni(api_key=os.environ["OMNI_API_KEY"]) as client:
    products = client.products.list(q="lamp")
    job = client.products.create(
        product={
            "sku": "SKU-100",
            "title": "Sample product",
            "price": 29.9,
            "currency": "SGD",
            "images": ["https://cdn.example.com/product.jpg"],
        }
    )
    created = client.jobs.wait(job_id=job["jobId"])

API keys are organization-scoped. Do not send organization_id on API-key requests.

from omnicommerce import AsyncOmni, Omni, OmniEnvironment

client = Omni(
    api_key="omni_sk_...",
    environment=OmniEnvironment.LOCAL,  # http://localhost:3000
    timeout_in_seconds=60,
    max_retries=2,
)

async with AsyncOmni(api_key=os.environ["OMNI_API_KEY"]) as client:
    products = await client.products.list(q="lamp")

client.with_raw_response.products.get(product_id="prod_123") returns data, status_code, headers, and url.

Resources

Every other documented tag is exposed the same way.

Errors

from omnicommerce import NotFoundError, Omni, OmniError

try:
    client.products.get(product_id="missing")
except NotFoundError:
    pass
except OmniError as error:
    print(error.status_code, error.body)

Webhooks

from omnicommerce import construct_event

event = construct_event(raw_body, headers, os.environ["OMNI_WEBHOOK_SECRET"])

Signature: HMAC-SHA256 over {timestamp}.{raw_body} compared to X-Omni-Signature.

Regenerate from OpenAPI

From the monorepo root:

yarn sdk:generate

That refreshes src/omnicommerce/_generated/resources.py from docs/openapi.json.