Introduction

Welcome to the QuickReceipts API — a RESTful service for making digital receipts that look like the real thing. As of now, our API is rather simple; designed to be fast, yet easy to use for developers at all levels of experience.

As we do not have any dedicated language libraries, we have provided code samples in cURL and Javascript. You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

The root URL for all calls to the API is: https://api.quickreceipts.co/

Authentication

An example of included Authorization Header:

# With cURL, you can just pass the correct header with each request
curl -X POST https://api.quickreceipts.co/api/receipt/create \
  -H 'Content-Type: application/json' \
  -H 'Authorization: $QUICKRECEIPTS_API_KEY'

// An example of including the Auth header with a Javascript request
var request = require('request');

var options = {
  method: 'POST',
  json: true,
  url: 'https://api.quickreceipts.co/api/receipt/create',
  headers: {
    'Authorization':'Bearer $QUICKRECEIPTS_API_KEY'
  }
};

request(options, function (error, response, body) {
   // -> response
});

Make sure to replace $QUICKRECEIPTS_API_KEY with your API key.

QuickReceipts uses API keys to allow access to the API. You can register a new QuickReceipts API key in our developer portal.

QuickReceipts expects the API key to be included in all API requests to the server in a header as a Bearer token. Like the following:

Authorization: Bearer $QUICKRECEIPTS_API_KEY

Receipts

Create a Receipt

# An example of /create with two purchased items
curl -X POST https://api.quickreceipts.co/api/receipt/create \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $QUICKRECEIPTS_API_KEY' \
-H 'cache-control: no-cache' \
-d '{
    "payment": {
        "method": "Visa ****3491"
    },
    "line_items": [
        {
            "category":"CLOTHING",
            "description":"POLO TOP M",
            "sku":"3793j8903ior",
            "taxable":false,
            "subtotal":39.99
        },
        {
            "category":"PHARMACY",
            "description":"GENxMEDICINE",
            "sku":"629hh8203dlp",
            "saving":2.99,
            "taxable":true,
            "subtotal":10.99
        }
    ],
    "taxRate": 0.08025
}'                          

// An example of /create request with two purchased items
const request = require('request');

var data = {
    {
        payment: {
                method: "Visa ****3491"
        },
        line_items: [
            {
                category:"CLOTHING",
                description:"POLO TOP M",
                sku:"3793j8903ior",
                taxable:false,
                subtotal:39.99
            },
            {
                category:"PHARMACY",
                description:"GENxMEDICINE",
                sku:"629hh8203dlp",
                saving:2.99,
                taxable:true,
                subtotal:12.99
            }
        ],
        taxRate: 0.08025
    }
};

var options = {
    method: 'POST',
    json: true,
    body: data,
    url: 'https://api.quickreceipts.co/api/receipt/create',
    headers: {
        'Authorization':'Bearer $QUICKRECEIPTS_API_KEY'
    }
};

request(options, function (error, response, body) {
   // -> response
});

The above returns JSON structured like this:

{
    "id": "Azs3PO735yPhqyxwHFpu",
    "direct_link": "https://view.quickreceipts.co/?id=Azs3PO735yPhqyxwHFpu",
    "qrcode_img": "data:image/png;base64,....encoded_content..."
}

This endpoint creates a digital receipt from a set of required and optional inputs. For the best results and formatting, be sure to have filled out your Account Details in the developer portal. We use the information provided in the developer portal to craft the header for each receipt created with your API Keys.

The QuickReceipts API is built to allow flexibility. So while some fields are required, what you submit in these fields is largely up to you; almost all String parameters are freeform text based on how you would like things to look on your receipt.

HTTP Request

POST https://api.quickreceipts.co/api/receipt/create

Post Body

Errors

The QuickReceipts API uses the following error codes: