API Reference PRO
Every route of the API, with its parameters, examples in four languages and a real response. New here? Start with your first request.
All routes start with:
https://api.fastyvendor.com/api/v1| Route | What it does | Scope |
|---|---|---|
GET /me | Who am I | any key |
GET /products | List products | products:read |
GET /products/{id} | Get a product | products:read |
PATCH /products/{id} | Change a product | products:write |
PATCH /products | Change many products | products:write |
GET /groups | List groups of variations | products:read |
GET /groups/{id} | Get a group of variations | products:read |
PATCH /groups/{id} | Change a group of variations | products:write |
GET /sales | List sales | sales:read |
GET /sales/{id} | Get a sale | sales:read |
POST /products/{id}/send | Send a product to an avatar | deliveries:write |
POST /sales/{id}/redeliver | Redeliver a sale | deliveries:write |
POST /customers/{key}/redeliver | Redeliver everything an avatar owns | deliveries:write |
GET /customers/{key}/purchases | Did this avatar buy it? | customers:read |
GET /customers | List customers | customers:read |
GET /customers/{key} | Get a customer | customers:read |
GET /customers/{key}/points | Points of a customer | points:read |
POST /customers/{key}/points | Give or take points | points:write |
GET /gift-cards | List gift cards | gift_cards:read |
GET /gift-cards/{id} | Get a gift card | gift_cards:read |
POST /gift-cards | Give a gift card | gift_cards:write |
POST /gift-cards/{id}/adjust | Add or remove balance | gift_cards:write |
POST /gift-cards/{id}/cancel | Cancel a gift card | gift_cards:write |
GET /coupons | List coupons | coupons:read |
GET /coupons/{id} | Get a coupon | coupons:read |
POST /coupons | Create a coupon | coupons:write |
PATCH /coupons/{id} | Change a coupon | coupons:write |
GET /discounts | List promotions | discounts:read |
POST /discounts | Create a promotion | discounts:write |
POST /discounts/{id}/end | End a promotion now | discounts:write |
GET /vendors | List vendors | vendors:read |
GET /vendors/{id} | Get a vendor | vendors:read |
PATCH /vendors/{id} | Change what a vendor sells | vendors:write |
GET /hubs | List hubs | vendors:read |
GET /reports/summary | Sales summary | reports:read |
OpenAPI
The same routes are in an OpenAPI 3.1 file, which needs no key. Load it in Postman or Insomnia to try the API without writing code, or generate a typed client:
bash
npx openapi-typescript https://api.fastyvendor.com/api/v1/openapi.json -o fasty.d.tsLSL examples
The LSL examples use two values you set once at the top of your script:
lsl
string API = "https://api.fastyvendor.com/api/v1";
string KEY = "fsk_…"; // the script must be no-copy and no-modifyThe answer arrives in http_response. See Using the API from LSL for complete scripts.