Quick Start

With this Quick Start guide, make your first request in just minutes

Tip: Shopwaive's quick start guide helps developers setup their first request in minutes. Use this guide to create an API key and make your first request.

Get your API keys

Every API request is authenticated with a Shopwaive API key, sent in the X-Shopwaive-Access-Token header. Any request that doesn't include a valid key will return an error.

To create a key:

1. In your Shopify admin, open the Shopwaive app.

2. Click Settings, then the Develop tab.

3. Under Shopwaive API keys, type a label (for example ERP sync) and click Create key.

4. Click Copy and keep the key somewhere safe. The full key is shown only once.

A key starts with swak_. One key is enough. You can create more, for example one for each developer or integration. To stop a key from working, select it in the list and click Revoke. Your other keys are not affected. A lost key cannot be shown again: revoke it and create a new one.

Already have an integration? The access token it sends in the X-Shopwaive-Access-Token header keeps working. You don't need to change anything.

Good to know: API keys should be handled with care and never exposed in unsecured environments. They should never be shared as they provide access to your store's data.

If a key is refused

A swak_ key that is refused returns HTTP 401. The message names the reason:

{"status": "failed", "message": "Invalid X-Shopwaive-Access-Token: key-revoked."}

Reason	What it means
not-a-shopwaive-api-key	The value starts with swak_ but is not a complete key. Check that you pasted the whole key.
key-not-recognised	No store has this key. It may have been deleted.
key-revoked	The key was revoked. Create a new one.
store-not-installed	Shopwaive is not installed on the store.
store-has-no-token	Contact [e-mail].

HTTP 503 means the key could not be checked. Retry the request.

Make your first request

To make your first request, send an authenticated request to the get customer endpoint. This will fetch a customer by email address. Ensure to include the X-Shopwaive-Access-Token and X-Shopwaive-Platform headers.

Get customer

get

Authorizations

X-Shopwaive-Access-TokenstringRequired

Path parameters

customer_emailstringRequired

The email of the customer to retrieve

Responses

200

Successfully fetched customer account

application/json

default

Unexpected error. Method not allowed

application/json

get/api/customer/{customer_email}

GET /api/customer/{customer_email} HTTP/1.1
Host: app.shopwaive.com
X-Shopwaive-Access-Token: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "customerid": "6659662610648",
  "email": "[e-mail]",
  "balance": 0,
  "expirationdate": "2025-01-19T18:50:15.75Z",
  "expires": "false",
  "orders": []
}

Take a look at how you might call this method using our official libraries, or via curl. Replace YOUR_API_KEY with your key:

curl

curl --location 'https://app.shopwaive.com/api/customer/[e-mail]' \
--header 'X-Shopwaive-Access-Token: YOUR_API_KEY' \
--header 'X-Shopwaive-Platform: shopify' \
--header 'Content-Type: application/json' \
--data ''

Node Axios

var axios = require('axios');
var data = '';

var config = {
  method: 'get',
maxBodyLength: Infinity,
  url: 'https://app.shopwaive.com/api/customer/[e-mail]',
  headers: { 
    'X-Shopwaive-Access-Token': 'YOUR_API_KEY', 
    'X-Shopwaive-Platform': 'shopify', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

NPM Package

var config = {
    headers: {
        "X-Shopwaive-Access-Token": "YOUR_API_KEY",
        "X-Shopwaive-Platform": "shopify",
        "Content-Type":"application/json"
    }
};

const Shopwaive = require('@shopwaive/credit');
const email = "[e-mail]";

async function getCustomer() {
    return new Promise((resolve, reject) => {
        let data = Shopwaive.getCustomer(config, email);
        resolve(data)
    });
}

getCustomer().then(res => {
    let data = res.data;
    if (data) {
        console.log(res.data);
    }
    console.log(res.status)
    console.log(res.statusText)

})

Python

import http.client
import json

conn = http.client.HTTPSConnection("app.shopwaive.com")
payload = ''
headers = {
  'X-Shopwaive-Access-Token': 'YOUR_API_KEY',
  'X-Shopwaive-Platform': 'shopify',
  'Content-Type': 'application/json'
}
conn.request("GET", "/api/customer/[e-mail]", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))