HTTP API · shop/v1
Shop API reference
37 operations. Operations for the catalog, cart, checkout, customer accounts, orders, payments, customers, subscriptions, and reports. Each one has its own page with parameters, request samples, and example responses.
https://your-site.example/api/shop/v1Read the introduction first for sessions, errors, and rate limits. Each site serves its live schema at /api/shop/v1/openapi.json.
Operations
Storefront
Cart
Checkout
Customer account
Orders
Payments
- POST
/orders/unpaidCreate an unpaid order - GET
/payment-linksList payment links - POST
/payment-linksCreate a payment link - GET
/payment-links/{id}Get a payment link - POST
/payment-links/{id}/payPay a payment link - POST
/payments/attempts/{id}/captureCapture a payment - POST
/payments/attempts/{id}/voidVoid a payment - POST
/payments/attempts/{id}/refundRefund a payment