Comment on page

Customer API

Get customer store credit balances; make adjustments based on their actions with the Shopwaive Customer API

Get customer account, balance, and transactions

get
https://app.shopwaive.com
/api/customer/{customer_email}
Get customer
key
value
X-Shopwaive-Access-Token
Store's platform API key for store (required)
X-Shopwaive-Platform
Store's platform (required)
Content-Type
Content type

Set customer balance

post
https://app.shopwaive.com
/api/customer
Set customer account balance

Header

key
value
X-Shopwaive-Access-Token
Store's platform API key for store (required)
X-Shopwaive-Platform
Store's platform (required)
Content-Type
Content type

Request Body

key
value
customer_email
Customer email address
balance
Value to assign to customer available balance
note
Description of transaction

Response Body

key
value
status
Status message
customerid
Customer id associated with store's platform
email
Customer email address
note
Description of transaction
previous
Customer's balance prior to request
balance
Customer's balance after successful request
activity
Ledger of customer transactions prior to request
Good to know: This API method sets customer balance to a predefined decimal value (i.e. independent of locale or currency). Currency is chosen within the store platform.

Adjust customer balance

put
https://app.shopwaive.com
/api/customer
Adjust customer account balance

Header

key
value
X-Shopwaive-Access-Token
Store's platform API key for store (required)
X-Shopwaive-Platform
Store's platform (required)
Content-Type
Content type

Request Body

key
value
customer_email
Customer email address
amount
Value to increment (add or subtract) to customer available balance
note
Description of transaction

Request Response

key
value
status
Status message
customerid
Customer id associated with store's platform
email
Customer email address
note
Description of transaction
previous
Customer's balance prior to request
transaction
Value of transaction
balance
Customer's balance after successful request
activity
Ledger of customer transactions prior to request
Tip: amount is defined as the total amount to add or subtract to the existing customer balance. Customers that do not yet have a Shopify account are automatically created. To set customer balance to a predefined amount, instead use Customer API POST