Developer Documentation

Comprehensive API references, integration guides, and technical deep dives for Store products.

API Documentation

REST API v2.1

Secure RESTful endpoints for integrating Store products with external systems. Requires OAuth 2.0 authentication.

POST /v2/auth/token
Obtain access token
Header: Content-Type: application/x-www-form-urlencoded
Request
{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_SECRET",
  "grant_type": "client_credentials"
}
Response (200)
{{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...6QZ",
  "token_type": "Bearer",
  "expires_in": 3600
}}
Authentication Error Handling
401 Unauthorized

Missing or invalid authentication credentials. Check that the client ID and secret are correctly set.

403 Forbidden

Insufficient permissions. Contact support to update your API scope.

Getting Started

Integration Example

Connect Store's analytics platform using our Python SDK. The following example demonstrates how to fetch product metrics.

pip install store-api-sdk
// Example usage
import store_api

config = store_api.Configuration()
config.api_key = "YOUR_API_TOKEN"
client = store_api.MetricsClient(config)

response = client.get_performance_data(product_id="X-48291")
for metric in response.metrics:
    print(f"{metric.label}: {metric.value}")

Webhook Setup

Receive real-time updates from our API using webhooks. Configure your endpoint to receive event notifications.

Webhook Event Structure
{{
  "event": "product.inventory.changed",
  "product_id": "X-48291",
  "quantity": 12345
}}

Error Codes

400 Bad Request

Malformed request body or missing required parameters

429 Too Many Requests

Rate limit exceeded. Retry after 60 seconds.

500 Internal Error

Service temporarily unavailable. Please retry or contact support.

Frequently Asked Questions

How do I get an API key?

Create a developer account through our contact page or use your existing business credentials to apply.

What authentication do you support?

We use industry-standard OAuth 2.0 client credentials flow. Token lifespan: 60 minutes. Rate limited to 1000rph.

Do you support Webhooks?

Yes, webhooks for inventory alerts and purchase notifications are available. Configure endpoints through your developer portal.

```