README.md

KAPI

Morena's Kustomz Serverless REST API

Overview

Getting Started
Usage
Built With
Contributing

Getting Started

Serverless REST API for Morena's Kustomz, an online cannabis accessory store.

Usage

Base URL: https://kapi.flexdevlopment.vercel.app

• Documentation follows OpenAPI Specification v3.0.3 standards.

Authenticated Endpoints

Endpoints that require a valid userToken (Shopify API token) query.

Customers

Retrieve information about shop customers.

• GET /customers
• GET /customers/[objectID]

Open Endpoints

Endpoints that don't require authentication.

Collections

Retrieve information about product collections.

• GET /collections
• GET /collections/[objectID]

Layout

Fetch the data used to render the storefront Layout component.

• GET /layout

Menus

Retrieve information about shop menus.

• GET /menus
• GET /menus/[objectID]

Pages

Retrieve information about online store pages.

• GET /pages
• GET /pages/[objectID]

Playlist

Fetch the storefront's Apple Music playlist data.

• GET /playlist

Policies

Retrieve information about store policies.

• GET /policies
• GET /policies/[objectID]

Products

Retrieve information about store products.

• GET /products
• GET /products/[objectID]

Reviews

Create and list product reviews.

• GET /reviews
• GET /reviews/[objectID]
• POST /reviews

Built With

• Algolia - Site Search & Discovery powered by AI
• Shopify Admin REST API - Shopify REST API
• Vercel - Hosting platform for serverless functions