Connect your workflow.
Access and authentication
API access requires an active Pro or Enterprise plan. Create or regenerate a store API key in Settings → API. Send Authorization: Bearer YOUR_KEY. Keep the key on your server. Requests are limited to 60 per minute per key.
Read your store
GET /api.php/v1/products · GET /api.php/v1/orders · GET /api.php/v1/order/{id} · GET /api.php/v1/customers. Each key is scoped to its store.
Import inventory
POST /api.php/v1/stock/{product_id} with JSON containing lines (an array of strings) and an optional variant_id. Each nonempty line is one item. A duplicate conflict returns HTTP 409; inspect the report before explicitly resubmitting with skip_duplicates: true.
Handle failures
Never expose your key in a public page. Check HTTP status codes, back off after rate limits, and review the actual stock state before retrying an import whose response was lost.