# REST API documentation

## 2024-11 Release Notes

### What's new in 2024-11 <a href="#whats-new-in-2024-04" id="whats-new-in-2024-04"></a>

The 2024-11 version of Shopwaive's APIs includes the following highlights:

### Action API <a href="#storefront-api" id="storefront-api"></a>

The <mark style="color:blue;">`GET`</mark> Actions <mark style="color:blue;">`/api/actions`</mark> endpoint is now part of the [Action API](https://api.shopwaive.com/reference/rest-api-documentation/action-api), a new endpoint that allows developers to search and filter actions beyond the existing single action endpoint /api/action/{action id}.  With the new endpoint, search actions by including any combination of query key value pairs `id`,`email`,`created_at_min`, or `created_at_max` appended to the /api/actions request. A maximum of 250 records per request are returned in the response body. [Learn more](https://api.shopwaive.com/reference/action-api#get-actions-endpoint)

## 2024-05 Release Notes

### What's new in 2024-05 <a href="#whats-new-in-2024-04" id="whats-new-in-2024-04"></a>

The 2024-05 version of Shopwaive's APIs includes the following highlights:

### Customer API <a href="#storefront-api" id="storefront-api"></a>

Response body of Customer API `GET` requests now include an option for returning a customer's orders through the <mark style="color:blue;">`orders`</mark> array by appending <mark style="color:blue;">**?orders=true**</mark> to the request url.

Response body of Customer API `GET` requests now return an abridged version of the customer's full account meta data, and do not include <mark style="color:blue;">`activity`</mark> or <mark style="color:blue;">`orders`</mark> arrays by default. To include these additional arrays in the response body, append optional query parameters <mark style="color:blue;">**?activity=true**</mark> or <mark style="color:blue;">**?orders=true**</mark> to the request url.

The <mark style="color:blue;">`transaction`</mark> field included in the <mark style="color:blue;">`activity`</mark> array and <mark style="color:blue;">`action`</mark> object is deprecated and has been sunset beginning April 1, 2024. Requests to the Customer API should not depend on the field being included in the response body.

<mark style="color:blue;">`expirationdate`</mark> and <mark style="color:blue;">`expires`</mark> fields can now be included in the request body to the Customer API PUT and POST endpoints. Enable multiple expiry dates to create powerful promotional offers that expire on different dates and with their own eligibility rules and requirements.

<mark style="color:blue;">`referralurl`</mark> is now returned if your Referral program is enabled. Learn more about Shopwaive's powerful [Referral program](https://docs.shopwaive.com/shopify/referral-program) for customers and affiliates. If new customers sign up using the referral link, you can choose to reward one or both the referrer and new customer

### Action API <a href="#storefront-api" id="storefront-api"></a>

The [Action API](https://api.shopwaive.com/reference/rest-api-documentation/action-api) is a new resource available with the 2024-05 release of Shopwaive's REST API. Developers can issue segments of credit with independent expiration and eligibility, and include these offers at Checkout with Shopwaive's Checkout Extension for Shopify Plus. The top-level account balance expiration date, if set, overrides any segment-level credit expiration.&#x20;

## Overview

The Shopwaive REST API includes the Customer, Order, and Action APIs

## Customer API

Customer API provides developers ability to query, increment, and set customer balances.

{% content-ref url="rest-api-documentation/customer-api" %}
[customer-api](https://api.shopwaive.com/reference/rest-api-documentation/customer-api)
{% endcontent-ref %}

## Action API

Action API provides developers ability to query, update expirations and meta data, and delete action properties.

{% content-ref url="rest-api-documentation/action-api" %}
[action-api](https://api.shopwaive.com/reference/rest-api-documentation/action-api)
{% endcontent-ref %}

## Order API

Create a checkout url link you can direct your customers to with store credit applied, and optionally include combined line item discounts.

{% content-ref url="rest-api-documentation/order-api" %}
[order-api](https://api.shopwaive.com/reference/rest-api-documentation/order-api)
{% endcontent-ref %}

{% hint style="info" %}
**Good to know:** Developers use the [Order API](https://api.shopwaive.com/reference/rest-api-documentation/order-api) to create a fully custom checkout experience. With Shopwaive's [Order API](https://api.shopwaive.com/reference/rest-api-documentation/order-api), you can apply credit to an order, set line items and quantities, and apply discounts to each line item (optional). Use cases include automation of custom invoice creation based on customer credit accounts balances, promos, and account activation requests that include checkout preview links with credit automatically applied.&#x20;
{% endhint %}