peachworks v0.0.5

Peachworks SDK

Node.js SDK for the Peachworks API, for making your own custom POS.

Prerequisites

You'll need an access token from Peachworks.

1. Navigate to https://my.peachworks.com/accounts/YOUR-ACCOUNT-ID/apps/pos
2. Select POS Systems
3. Select your POS system
4. Select Access Credentials
5. Copy your token

Getting started

Step 1: Initialize the SDK

To initialize the SDK, you'll just need that access token.

const PeachworksClient = require('peachworks');

var peachworks = new PeachworksClient({
    accessToken: 'YOUR ACCESS TOKEN'
});

Step 2: Configure your POS

var c = peachworks.createConfiguration({
        items: [{
            id: "001",
            name: "matt's famous shakshuka"
        }]
    }); 

Step 3: Record a transaction

var t = peachworks.createTransaction({
    order_number: 1234,
    items: [{id: "001"}],
    total: 12.34,
    customer_id: 1,
    inclusive_tax: 0,
    exclusive_tax: 0
});

t.addItem({
    item_id: 'shakshuka',
    quantity: 1,
    price: 12.34,
});

t.record();

Congratulations! You've just recorded your first sale.

Step 4: Profit!

Actually, you profited in step 3.

Options

Want to apply a discount?

transaction = {
    .
    .
    .
    discount_amount: 5.00,           // amount of discount, required
    discount_id: 'citywide_special', // id of this discount, required
    discount_quantity: 1,            // optional, defaults to 1
    .
    .
    .
}

TODO

• Support more use cases
• Support configuration

Acknowledgements

Special thanks to Matt Craig of Peachworks for his assistance.