Connectors

A connector links minipim to another system. BigCommerce and Shopify pull a store’s catalog into minipim and push edits back. Headless sends outbound webhooks to your own app. You can install more than one of each, for example one per store.

In the admin

Connectors live under Catalog → Connectors.

1. Under Available, click Install (or Add another) next to the connector type.
2. BigCommerce: enter a Name, the Store hash (from store-abc123.mybigcommerce.com) and an Access token. The dialog lists the token scopes to grant: Products (Modify, or Read-only for pull only), Content (Read-only, needed for web pages and blog posts) and Channel Settings (Read-only).
3. Shopify: the first time, the dialog asks for your Shopify app’s Client ID and Client secret (click Save app & continue), then you enter the Store domain (your-store.myshopify.com) and click Connect to Shopify. To skip the app, click Use a manual access token instead → and paste an Admin API access token. The saved app also appears under System → Settings → OAuth apps.
4. Click Install (or Connect to Shopify). minipim checks the credentials before saving; bad credentials fail the install.
5. On the installed row, click Pull to import, or Push to send minipim’s values back. Click the status line to see Recent syncs with their stats.
6. For BigCommerce, click Enable under Webhooks to have product changes in the store refresh minipim automatically.

Use the pencil icon to rename a connector or rotate its access token, and the trash icon to uninstall.

With the API

Method	Path	What it does
GET	/v1/connectors/available	Connector types on this deployment and their capabilities
GET / POST	/v1/connectors	List or install connectors
PATCH / DELETE	/v1/connectors/{id}	Update config, name or credentials; uninstall
POST	/v1/connectors/{id}/sync	Start a sync: { "direction": "pull" | "push" | "both" }
GET	/v1/connectors/{id}/syncs	Last 50 syncs with status and stats
POST	/v1/connectors/{id}/webhooks/enable / disable	Inbound store webhooks
GET	/v1/products/{id}/connector-metadata	Source ids such as bc_product_id

curl -X POST https://api.minipim.com/v1/connectors/$CONNECTOR_ID/sync \
  -H 'Authorization: Bearer pim_…' -H 'Content-Type: application/json' \
  -d '{ "direction": "pull" }'

A sync returns immediately with status running. Poll GET /v1/connectors/{id}/syncs until it reads completed, partial or failed.

Pull modes

The admin installs BigCommerce and Shopify connectors in wipe mode. A full pull first deletes every product that connector previously imported, with its variants and attribute values, plus the channels it created for that store, then imports the store again. Values you typed into minipim on those products are lost on the next full pull. Products you created by hand, and those from other connectors, are untouched.

A BigCommerce webhook refresh is always incremental: it re-imports only the product that changed, and a product deleted in the store is archived in minipim rather than deleted.

Rules and limits

• BigCommerce pulls products, variants, categories, brands, modifiers, images and, with the Content scope, web pages and blog posts. Shopify pulls products, variants, images and tags.
• Pulls do not emit per-product events. Each sync ends with one connector.sync.completed (or connector.sync.failed).
• Pushes update existing store products only. When a product imported from BigCommerce or Shopify is updated in minipim, that product is also pushed to the store right away.
• Inbound webhooks are BigCommerce only. Enabling them subscribes to product created, updated and deleted events when minipim can register them, or returns a URL to register by hand.
• A server restart during a sync can leave it shown as running.
• Uninstalling removes the connector, its sync history, its store webhooks and its source-id links. Imported products stay.
• Each pull re-adds the connector’s standard attributes (price, sale price and so on) if they are missing.