Keepup Store Docs
Home
  • Welcome
  • 💡Tutorials
    • Overview
    • Account Set Up
    • Sales
      • 💡How to Create a Quote, Invoice or Receipt
      • 💡How to Edit a Quote or an Invoice
      • 💡How to Record Payment for a Quote or an Invoice.
      • 💡How to Filter Sales
      • 💡How to Delete a Sale
      • 💡How to Print a Sale
    • Inventory
      • 💡How to Add a Product
      • 💡How to Edit a Product
      • 💡How to Filter Products
      • 💡How to Delete a Product
      • 💡How to Record Damaged or Lost Products
      • 💡How to Import Products
    • Orders
      • 💡How to Create an Order
      • 💡How to Update an Order
      • 💡How to Filter Orders
      • 💡How to Print Order Labels
      • 💡How to Delete an Order
    • Customers
      • 💡How to Add a Customer
      • 💡How to Import Customers
      • 💡How to Edit a Customer
      • 💡How to Filter Customers
      • 💡How to Delete Customers
      • 💡How to Message Customers
      • 💡How to View Customers Feedback
      • 💡How to Buy SMS/Email Bundle
    • Expenses
      • 💡How to Record an Expense
      • 💡How to Edit an Expense
      • 💡How to Record Payment for an Expense
      • 💡How to Filter Expenses
      • 💡How to Delete an Expense
      • 💡How to View Expenses Analytics
    • Subscription
      • 💡How to Renew Your Subscription
    • Storefront
      • 💡How to Set Up Your Storefront
      • 💡How to Publish and Unpublish Your Storefront
      • 💡How to Update Storefront Settings
      • 💡How to View Storefront Orders
      • 💡How to View Abandoned Carts
    • Purchase Order
      • 💡How to create a Purchase Order
      • 💡How to edit a Purchase Order
      • 💡How to filter Purchase Orders
      • 💡How to delete Purchase Orders
      • 💡How to update a Purchase Order status
      • 💡How to record payment for a Purchase Order
    • Business Settings
      • 💡How to Update Business Information
      • 💡How to Verify your Business
      • 💡How to Manage Your Business API
      • 💡How to Update Sale Settings
      • 💡How to Manage Your Tax Profiles
      • 💡How to Manage Your Delivery and Pick Up Locations
      • 💡How to Manage Your Online Payments Options
      • 💡How to Manage your Offline Payments Options
    • Raw Materials
      • 💡How to Add a Raw Material
      • 💡How to Edit a Raw Material
      • 💡How to Import Raw Materials
      • 💡How to Filter Raw Materials
      • 💡How to Delete a Raw Material
      • 💡How to Record Damaged or Lost Raw Materials
      • 💡How to Create a Manufacturing Order
      • 💡How to Edit a Manufacturing Order
      • 💡How to Filter Manufacturing Orders
      • 💡How to Update a Manufacturing Order Status
      • 💡How to Delete a Manufacturing Order
    • Team Members
      • 💡How to Add Team Members
      • 💡How to Update a Team Member's Permissions
      • 💡How to Filter Team Members
      • 💡How to Remove a Team Member
      • 💡How to View Team Members' Action Logs
    • Damages & Loss
      • 💡How to Filter Damages & Loss
      • 💡How to Edit a Damaged or Lost Item
      • 💡How to Delete a Damaged or Lost Item
    • How to Access Keepup Store Version 2.0
  • âš¡API
    • Introduction
    • Sales
      • âš¡List Sales
      • âš¡Fetch Sale
      • âš¡Add Sale
      • âš¡Edit Sale
      • âš¡Update Balance
      • âš¡Cancel Sale
      • âš¡Refund Sale
    • Products
      • âš¡List Products
      • âš¡Fetch Product
      • âš¡Add Product
      • âš¡Edit Product
Powered by GitBook
On this page
  • API Basics
  • HTTP Methods
  • Authentication
  • Requests and Response
  • Success Response Format
  • Error Response Format
  1. API

Introduction

Learn how to integrate our APIs into your application.

PreviousHow to Access Keepup Store Version 2.0NextSales

Last updated 1 year ago

API Basics

Before you begin!

You should that you can test the API against. We will provide you with an API key that you can use to make API calls.

The Keepup Store API provides access to almost all the functionalities available in our application, enabling you to extend these features into your own projects. It is designed to follow RESTful principles and is structured around the key resources that you will commonly interact with.

HTTP Methods

POST

Create a new business record. This request is used to add new data to the system.

GET

Retrieve data about a business record. This request is used to view details without making any changes.

PUT

Update an existing business record. This request is used to modify all or part of the existing details of a record.

DELETE

Remove a business record from the system. This request permanently deletes a record.

Authentication

Authenticate your API calls by including your API key in the Authorization header of every request you make. You can manage your API key from your page.

The API key however, is to be kept secret. If for any reason you believe your API key has been compromised or you wish to reset your API key, you can do so from the page.

Secure your API key

Do not commit your API key to git, or use it in client-side code.

Authorization headers should be in the following format:

Authorization: Bearer API_KEY

Sample Authorization Header

Authorization: Bearer sample.eyJhY2Nlc3NfZGF0YSI6eyJ0b2tlbiI6IjM2ODUzMTgzYzBmNzY0NmZiZmFkN2ViYTdjZTkyZjZmYWJkMjcyMTZkY2U5Njk4OTQ0YTZhODBlNmQ5ZWsdfsadfeafaesfdsctpoosOSDoosdiOiJhcGkifSwiaWF0IjoxNzA1ODUwMDcxfQ.xlFapi-key-kus

Requests and Response

Both request body data and response data are formatted as JSON. Content type for responses will always be application/json. Generally, all responses will be in the following format:

Success Response Format

status

number

The HTTP status code indicating a successful operation. 200 is standard for successful requests, 201 is used for requests that result in creation, and 204 is used when the request has been successfully processed but there is no content to return (often used in delete operations).

message

string

A message indicating that the request has been successfully completed. Note that for a 204 response, typically no message is included because no content is returned.

data

object

An object containing any data returned by the API as a result of the request. For 204, this object is typically empty as no data is returned.

Error Response Format

status

number

The HTTP status code indicating an error. Each code has specific meanings: 400 for bad requests, 500 for internal server errors, 401 for unauthorized, 404 for not found, and 402 for payment required.

message

string

A general message stating that the request failed.

data

object

An object containing details about the specific errors encountered during the request. This may include validation errors or other detailed information.

âš¡
create a Keepup Store account
business settings
business settings