Home DocsAPI Reference

API Reference

Complete reference for the BrandUp REST API. All endpoints require authentication.

https://api.brandupfactory.com/v2

Authentication

All API requests require a Bearer token in the Authorization header. Get your API key from the dashboard.

curl -X GET "https://api.brandupfactory.com/v2/shops" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Endpoints

GET/v2/shops

List all shops

GET/v2/shops/:id

Get shop details

POST/v2/shops

Create a new shop

PATCH/v2/shops/:id

Update shop

DELETE/v2/shops/:id

Delete shop

GET/v2/weather/current

Get current weather

GET/v2/weather/forecast

Get weather forecast

POST/v2/webhooks

Response Format

All responses are JSON. Successful responses include a data field and paginated endpoints include meta.

{
  "data": [
    {
      "id": "shop_abc123",
      "name": "My Store",
      "domain": "mystore.myshopify.com",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 20
  }
}

Error Codes

Code	Name	Description
400	Bad Request	Invalid request parameters
401	Unauthorized	Missing or invalid API key
403	Forbidden	Insufficient permissions
404	Not Found	Resource does not exist
429	Rate Limited	Too many requests
500	Server Error	Internal server error

Rate Limiting

API requests are rate limited to ensure fair usage. Limits are applied per API key.

Standard

1,000 req/min

Enterprise

10,000 req/min

Back to Documentation