Points & Earn Rules
Approve pending point transactions
Approves pending point transactions and converts them to available points.
When points are pending:
- Orders with pending fulfillment
- High-risk transactions requiring manual review
- Bulk point grants awaiting approval
- Refund/return waiting periods
- Custom approval workflows
Two approval modes:
Mode 1: Approve all pending transactions
- Set approveAllPendingTransactions=true
- Request body is ignored
- Approves ALL pending transactions for the shop
- Use for bulk approvals or automated workflows
Mode 2: Approve specific transactions
- Set approveAllPendingTransactions=false (or omit parameter)
- Provide pendingPointsApprovalList in request body
- Each item needs: transactionId and customerId
- Approves only specified transactions
- Use for selective/manual approval
If you send neither a list nor approveAllPendingTransactions=true, the request fails with 400.
How approval works:
- Checks that you sent a list or approveAllPendingTransactions=true
- Queues the approval to run in the background
- Returns 204 immediately (doesn’t wait for completion)
- Background process:
- Updates transaction status from PENDING to APPROVED
- Adds points to customer’s availablePoints
- Updates creditedPoints total
- Syncs to Shopify metafields
Important notes:
- This is an ASYNCHRONOUS operation
- Returns 204 immediately, processing happens in background
- Points may take a few seconds to appear in customer account
- No rollback after 204 response
- Only PENDING transactions change status; APPROVED and REJECTED ones keep theirs
- Store credit is issued only for store credit transactions this call moves from PENDING to APPROVED. Transactions in the list that are already APPROVED or REJECTED are skipped, so a retried call doesn’t credit the customer twice
Request body structure (for specific approvals):
[
{
"transactionId": 98765,
"customerId": 12345
}
]
Best practices:
- Use approveAllPendingTransactions=true for scheduled/automated approvals
- Use specific approval list for manual review workflows
- No webhook event or Flow trigger reports approval. To see when it completes, poll the customer’s point transaction history until the transaction’s status is APPROVED
- Don’t call repeatedly - it’s queued asynchronously
- Consider rate limiting on your side for bulk approvals
Common use cases:
- Approve points after order fulfillment
- Batch approval at end of day/week
- Manual approval after fraud review
- Approve after return/refund window closes
- Integration with external approval systems
Error handling:
- 204: Success, approval queued (this is success, not an error)
- 400: No approval list and approveAllPendingTransactions isn’t true, or the request body isn’t a list
- 401: Invalid API key
PUT
/
api
/
external
/
approve-pending-transactions
Approve pending point transactions
curl --request PUT \
--url https://loyalty-admin.appstle.com/api/external/approve-pending-transactions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
[
{
"customerId": 123,
"transactionId": 123
}
]
'import requests
url = "https://loyalty-admin.appstle.com/api/external/approve-pending-transactions"
payload = [
{
"customerId": 123,
"transactionId": 123
}
]
headers = {
"X-API-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([{customerId: 123, transactionId: 123}])
};
fetch('https://loyalty-admin.appstle.com/api/external/approve-pending-transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://loyalty-admin.appstle.com/api/external/approve-pending-transactions';
const options = {
method: 'PUT',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([{customerId: 123, transactionId: 123}])
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://loyalty-admin.appstle.com/api/external/approve-pending-transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
[
'customerId' => 123,
'transactionId' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://loyalty-admin.appstle.com/api/external/approve-pending-transactions"
payload := strings.NewReader("[\n {\n \"customerId\": 123,\n \"transactionId\": 123\n }\n]")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://loyalty-admin.appstle.com/api/external/approve-pending-transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"customerId\": 123,\n \"transactionId\": 123\n }\n]"
response = http.request(request)
puts response.read_body{
"status": 400,
"title": "Please provide an approval list or set approveAllPendingTransactions to true"
}{
"detail": "Invalid authentication",
"status": 401
}Query Parameters
Response
Approval process started successfully (asynchronous operation). Points will be added to customer accounts within a few seconds.
⌘I
Approve pending point transactions
curl --request PUT \
--url https://loyalty-admin.appstle.com/api/external/approve-pending-transactions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
[
{
"customerId": 123,
"transactionId": 123
}
]
'import requests
url = "https://loyalty-admin.appstle.com/api/external/approve-pending-transactions"
payload = [
{
"customerId": 123,
"transactionId": 123
}
]
headers = {
"X-API-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([{customerId: 123, transactionId: 123}])
};
fetch('https://loyalty-admin.appstle.com/api/external/approve-pending-transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://loyalty-admin.appstle.com/api/external/approve-pending-transactions';
const options = {
method: 'PUT',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([{customerId: 123, transactionId: 123}])
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://loyalty-admin.appstle.com/api/external/approve-pending-transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
[
'customerId' => 123,
'transactionId' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://loyalty-admin.appstle.com/api/external/approve-pending-transactions"
payload := strings.NewReader("[\n {\n \"customerId\": 123,\n \"transactionId\": 123\n }\n]")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://loyalty-admin.appstle.com/api/external/approve-pending-transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"customerId\": 123,\n \"transactionId\": 123\n }\n]"
response = http.request(request)
puts response.read_body{
"status": 400,
"title": "Please provide an approval list or set approveAllPendingTransactions to true"
}{
"detail": "Invalid authentication",
"status": 401
}