Purchase Action Hold Points Settings: All Items From Order Ship Date

Written By Devin O'Neill ()

Updated at April 3rd, 2025

Introduction

In the context of a purchase action, the hold points settings defines how points are managed when an order is placed but not yet shipped. When hold points is configured, points are typically not awarded until the items are shipped.
The hold point type, “All Item From Order Ship Date“, will apply the release date to the order points from the date when all the products have been shipped. The countdown for the holding period begins from the date when the entire order is shipped.

Navigation : Products >Actions >Purchase >Points Limitation

Configuration

Click Edit to configure the purchase action.
In the Points Limitation wizard, the “Hold Points” field offers three options for selecting the hold points type.
Select “All Item From Order Ship Date“ from the options, this feature allows the user to configure the number of days the points should be held after all the items from the order has been shipped.

All Items From Order Ship Date

In the Purchase Action hold point settings, the all item from order ship date can be configured with different hold durations.
This hold type allows the user to set the entire order’s points for release when all products have been shipped, starting the holding period countdown from the date of the order’s full shipment.
For example, “All Item From Order Ship Date = 5 days”, which means that points for an order will be on hold until the last item in that order is shipped, and an additional 5 days have passed since the order was shipped. So, even if some items in the order are shipped earlier, the points for the entire order will not be awarded until all items have been shipped and 5 days have passed.
Let’s consider a use case where the all item from order ship date setting is configured for 5 days.

Use Case: Create an Order

To create an order in the order API, the user need to send a request with details like the product ID, quantity, and unit price for each item. Here is the request body schema with the order details.

Request

{
    "id": "{{test_order_id}}",
    "userId": "{{email_id}}",
    "orderDate": "2024-05-24 20:10:10",
    "orderDetail": [
        {
            "id": "H2",
            "quantity": "2",
            "unitPrice": "100"
        }
    ]
}

Response

{
    "siteId": "146031180",
    "id": "A1716543653294",
    "userId": "bh919@gmail.com",
    "orderDate": "2024-05-24T16:10:10+0000",
    "pointsAwarded": 0,
    "pointsExpirationDate": "",
    "pointsOnHold": 200,
    "previousTier": "",
    "updatedUserTier": "",
    "currentTier": "Bronze",
    "nextTier": "Silver Premium",
    "pointsToNextTier": 101,
    "currentTierPurchaseRatio": "1",
    "spendAmountToNextTier": 0,
    "tierAchievedDate": "2024-05-24T05:37:16+0000",
    "tierExpirationDate": "0000-00-00 00:00:00",
    "orderDetail": [
        {
            "id": "H2",
            "quantity": 2,
            "unitPrice": 100,
            "points": 200
        }
    ],
    "updatedAvailablePoints": 0,
    "updatedLifetimePoints": 0
}

The points awarded for this order is zero, as the all item from order ship date for the hold points type is configured for 5 days, so the points 200 are on hold.

Activity API

GET: users/{{email_id}}/activity

In the GET Users Activity related to this order, the point status is “Hold”.

Order Details API

In the order details API, the points awarded for the order are zero, and the points on hold are 200.

Reports:

Interaction report

The interaction report displays that the points are zero, and the points are not released immediately because the hold points type for the all item from order ship date is configured for 5 days for the purchase action.

Order report

The order report for the hold points type with the all item from order ship date configured for 5 days displays that 200 points are on hold, zero points are earned, and zero points are awarded.

Hold Points report

The hold points report for this order shows that 200 points are on hold.
In the hold points report, the release date is not displayed until the order is fully shipped. The release date column remains blank until then.

Hold Points report-2nd level

The second-level hold points report for this order ID displays that the status for the product in this order is On Hold, and the release date is also blank.
The release date will not be displayed until the order is fully shipped.

Release Point

Note: Even if the hold type is selected as All Item From Order Ship Date, the points can still be manually released regardless of the configured days.

To release points manually at the product level, follow these steps:

Select the line item and then click the “Release Points“ button for the selected item.
Enter the reason for releasing the points in the confirmation and then click ‘Yes’.

3. Regardless of the reason entered during the release of points, it is displayed in both the “Interaction Report” and the “Member Activity API” in the Reason field.

4. Points will be credited into the member's account.