API Overview

Complete reference for all Pixlpay API endpoints.

Base URL

https://yourstore.pixlpay.net/api/external/v1/

Authentication

All endpoints require Bearer token authentication:

Authorization: Bearer YOUR_API_TOKEN

Response Format

Success Response

{
  "success": true,
  "data": { ... }
}

Paginated Response

{
  "success": true,
  "data": [ ... ],
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 15,
    "total": 75
  }
}

Error Response

{
  "success": false,
  "error": "Not Found",
  "message": "Product not found"
}

Endpoints Overview

Products

Method	Endpoint	Description
GET	/products	List all products
GET	/products/{id}	Get single product

Orders

Method	Endpoint	Description
GET	/orders	List all orders
GET	/orders/{id}	Get single order
POST	/orders/{id}/fulfill	Mark order fulfilled

Customers

Method	Endpoint	Description
GET	/customers	List all customers
GET	/customers/{id}	Get single customer

Analytics

Method	Endpoint	Description
GET	/analytics/revenue	Revenue statistics
GET	/analytics/sales	Sales statistics

Webhooks

Method	Endpoint	Description
GET	/webhooks	List webhooks
POST	/webhooks	Create webhook
DELETE	/webhooks/{id}	Delete webhook
POST	/webhooks/{id}/test	Test webhook

Pagination

Use page and per_page query parameters:

GET /products?page=2&per_page=25

• Default per_page: 15
• Maximum per_page: 100

Filtering

Most list endpoints support filtering:

GET /orders?status=completed&from=2025-01-01&to=2025-01-31

Sorting

Use sort and order parameters:

GET /products?sort=price&order=desc

Rate Limiting

• 60 requests per minute per token
• Headers indicate current status
• 429 response when exceeded