Products & catalogue

The Commerce API manages your locations, categories, products and stock. Products live in the same catalogue that powers the Quickli App — with your explicit consent controlling whether customers can see them.

Endpoints

POST/locations
Register an outlet / pickup point2 tokens
GET/locations
List locations & service areas1 token
PATCH/locations/:id/visibility
Per-location app visibility2 tokens
GET/categories
Browse catalogue categories1 token
POST/products
Create a product2 tokens
GET/products
List & filter1 token
PATCH/products/:id
Update fields2 tokens
PATCH/products/:id/stock
Fast stock sync2 tokens
POST/products/:id/publish
Publish (consent required)2 tokens
POST/products/:id/unpublish
Hide instantly2 tokens
POST/products/bulk
Upsert up to 500 by externalId1/item
DELETE/products/:id
Soft-delete2 tokens

Creating products

create-product.sh
curl -X POST https://api.quickliapp.com/v1/open/products \
  -H "Authorization: Bearer qk_live_…" \
  -d '{
    "externalId": "SKU-0042",
    "name": "Signature Jollof Rice",
    "description": "Smoky party-style jollof with grilled chicken",
    "price": 3500,
    "categoryId": "cat_…",
    "locationId": "loc_…",
    "productType": "fixed",
    "availableQuantity": 50,
    "images": ["https://cdn.yoursite.com/jollof.jpg"],
    "variants": [
      { "name": "Portion", "isRequired": true,
        "items": [ { "name": "Regular", "price": 0 }, { "name": "Large", "price": 1000 } ] }
    ]
  }'
  • productType: fixed (tracked stock via availableQuantity) or on-demand (always available, toggled via inStock).
  • variants & options mirror the Quickli App choice groups (size, spice level, add-ons) with optional price deltas.
  • externalId is your SKU — the join key for bulk upserts. Unique per organization.

Stock synchronisation

stock.sh
curl -X PATCH https://api.quickliapp.com/v1/open/products/prd_…/stock \
  -H "Authorization: Bearer qk_live_…" \
  -d '{ "availableQuantity": 12 }'

# sold out?
  -d '{ "availableQuantity": 0 }'   // auto-hides from the app until restocked

The stock endpoint is deliberately cheap and fast — call it from your POS/webshop webhooks to keep the app accurate. Zero stock hides the product from customer discovery automatically without unpublishing it.

Marketplace visibility & consent

Publishing to the Quickli App requires your organization-level consent (marketplaceConsent.visibleOnQuickliApp) — it is off by default and controlled in Portal → Settings → Marketplace presence, or per-location via the visibility endpoint.

  • Consent off: products remain usable through the API (your own checkout can still dispatch deliveries for them) but are invisible to Quickli App customers.
  • Consent on: discovery follows the same location-based rules as existing Quickli vendors — customers see your outlets when they are nearby, open, and have live products.
  • Review: unless auto-publish is enabled, new marketplace listings pass a quick quality review (names, prices, photos). You receive product.approved / product.rejected webhooks with reasons.
  • Instant off-switch: disabling consent hides every outlet and product from the app immediately; nothing is deleted and re-enabling restores everything.

Product states

draft → pending_review → live (discoverable) · rejected (reason provided) · unpublished (hidden, restorable). API responses always include the current state and any review feedback.

Bulk import

POST /products/bulk upserts up to 500 products per request, matched on externalId. The response is a per-item report (accepted / rejected with field errors). For full catalogue migrations use the CSV import job in the portal — you get an import.completed webhook with the results file.