Connecting a store

WooCommerce

Generate REST API keys in WooCommerce → Settings → Advanced → REST API with Read access. In Dashboard → Sources, choose WooCommerce and enter your store URL plus the consumer key (ck_…) and consumer secret (cs_…).

BigCommerce

Create a store-level API account with the Products: read-only scope. Connect with your store hash and the access token. Optionally set your storefront base URL so product links point at your public store.

Magento

Magento (Adobe Commerce) connects via an integration access token with catalog read permissions. Provide your store base URL (the REST API is reached at {baseUrl}/rest/V1) and the token.

Feed URL

Already publish a product feed? Point ShelfReady at its URL — no credentials needed. Supported formats are Google Shopping XML (RSS 2.0 or Atom) and CSV/TSV; the format is auto-detected, and common column names are mapped automatically. Feed URLs must be HTTPS and at most 50 MB. You can set a default currency for feeds whose prices carry none.

CSV / XLSX upload

No feed and no supported platform? Upload a CSV or XLSX file in the dashboard. ShelfReady guesses the column mapping from your headers and lets you remap columns before importing. Re-upload whenever your catalog changes.

API push

Push canonical-shaped items straight from your own systems with POST /api/v1/catalog. The first push auto-provisions an api source; every push validates items and upserts them through the same pipeline as the other connectors.

curl -X POST https://useshelfready.com/api/v1/catalog \
  -H "Authorization: Bearer $SHELFREADY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "items": [{ "externalId": "SKU-1", "title": "Ridgeline 2P Tent" }] }'

Sync behavior

Pull sources (WooCommerce, BigCommerce, Magento, feed URL) re-sync automatically every six hours. You can also sync on demand from the dashboard or with POST /api/v1/syncs. Every successful sync re-renders your feeds, re-runs the audit, and emits a sync.completed webhook.