User API overview

The User API gives store owners programmatic access to everything in the dashboard. Base URL: https://app.papelship.com/api_user/api/v1 Authenticate with the x-api-key and x-store-hash headers. See Authentication.

Resources

Analytics

Revenue, orders, and customer totals for any date range.

Products

Create, update, and delete products and their pricing.

Categories & groups

Organize products into categories and collections.

Coupons

Create percent or fixed discount codes.

Customers

View customers and their purchase history.

Invoices

List orders, complete them, and mark refunds.

Prices are in cents

All *_cents fields are integers in the smallest currency unit. For example, price_cents: 2999 is $29.99.

Pagination

List endpoints such as GET /products accept limit (default 50) and offset (default 0):

curl "https://app.papelship.com/api_user/api/v1/products?limit=50&offset=100&status=active" \
  -H "x-api-key: your_api_key" \
  -H "x-store-hash: your_store_hash"

Guides

Endpoints

Resources

Analytics

Products

Categories & groups

Coupons

Customers

Invoices

Prices are in cents

​Resources

Analytics

Products

Categories & groups

Coupons

Customers

Invoices

​Prices are in cents

​Pagination

Resources

Prices are in cents

Pagination