Documentation

Components

Integrations

Dashboard

Support

Retrieves a cart by its ID. This endpoint can be used to retrieve the details of an existing cart, including the items, quantities, and total price.

Retrieve a Cart

Retrieves the details of a specific shopping cart by its ID.

apiKeyAuth

Get Cart by ID

Introduction

Build Options

Welcome to the Krypton and Auto Deploy setup guide. This tutorial will walk you through the steps to create a new Krypton storefront, link it to your Crave Up account, and deploy it using Auto Deploy.

Development

Fundamentals & Concepts

Retrieves the basic information for a specific location, such as its name, address, contact details, logo, cover photo, and ordering capabilities.

Get Location Info

Retrieves the status of a specific location (e.g., open or closed) based on its operating hours.

Get Location Status

Retrieves the available order methods (e.g., takeout, delivery, dine-in) for a specific location.

Get Fulfillment Methods

Retrieves the operating hours intervals for a specific location, providing information on when orders can be placed for different fulfillment methods.

Get Operating Hours Intervals

Retrieves the gratuity configuration for a specific location, including if tipping is enabled, allowed gratuity percentages, and the default gratuity percentage.

Get Gratuity Configuration

Retrieves the menus for a specific location, along with the availability status and scheduling details.

Get Location Menus

 Creates a new cart for a customer. This endpoint requires cart data including items, fulfillment method, location, and other details as specified in the request body.

Create a Cart

Updates an existing cart. This endpoint can be used to modify the contents of a cart, such as adding or removing items, updating quantities, or changing the delivery address.

Update a Cart

Delete a Cart

Add Item to Cart

Updates an item in an existing cart. This endpoint can be used to modify the quantity or options of an item in the cart.

Update Cart Item

Remove Item from Cart

Retrieves the authenticated customer information.

Get Customer Data

Retrieves customer addresses. (Note: Implementation logic is pending.)

Get Customer Addresses

Retrieves orders placed by the authenticated customer.

Get Customer Orders

Logs in or registers a customer using their phone number or email address. On successful registration or login, a verification OTP is sent to the customer for security purposes.

Login or Register Customer

Verifies a customer OTP (One-Time Password) code, allowing them to proceed with their order or other actions.

Verify Customer OTP

Logs out the customer from the current device.

Logout Customer from Current Device

Logout Customer from All Devices

Retrieves the products for a specific category within a location.

Get Category Products

Creates a new Stripe subscription for a merchant.

Subscribe to a Plan

This endpoint registers a new team member with their associated merchant and location details. Merchants can use this endpoint to create accounts for their staff, including managers, servers, chefs, and other team members. The request should include relevant information such as name, role, and contact details of the team member.

Getting Started

Krypton & Auto Deploy

Storefront APIs

Admin APIs

Retrieve a Cart

Authorizations

Path Parameters

Response