Purchase Action Hold Points Settings: As per Order Item Ship Date

Written By Devin O'Neill ()

Updated at April 4th, 2025

Introduction

  • In the context of a loyalty program Purchase action: holding points specifically refers to the temporary suspension or freezing of loyalty points that have been earned but are not yet available for redemption or other purposes.
  • This document is designed to offer an in-depth insight into the limitations associated with hold points, specifically emphasizing the “Order Item Ship Date.”
  • By exploring the use cases for the 'order item ship date' hold type in our order API, we gain a clearer understanding of how hold points function in real-world scenarios.

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.
  • This feature allows the user to configure the number of days the points should be held after the order has been placed.

  1. Order Placed Date: The points will be held X number of days from the order's date. These points get released when the order is shipped or the released date configured in the site admin.
  2. Order Item Ship Date: The points will be held X number of days from the date the order is shipped. These points will be released after the day(s) are configured in the site admin.
  3. All Item From Order Ship Date: This option allows the user to set the hold points until the last item of the order is shipped.
    If no hold points type is selected, then by default, action points will be released immediately as soon as a member performs the specified action.

Note: If no hold points type is selected, then by default, action points will be released immediately as soon as a member performs the specified action.

Purchase Action Hold Points Settings:

Order Item Ship Date:

  • In the Purchase Action hold point settings, the Order Item Ship Date can be configured with different hold durations.
  • For example, “Order Item Ship Date = 0 Days”, means the points earned based on the ship date of items in an order are immediately available to the member. There is no delay or hold period applied to these points. Suppose a customer places an order on January 1st, and all the items ship on the same day. The points earned from this order would be instantly available for the customer to use towards a future purchase, as the hold points period is defined as zero days.
  • Order Item Ship Date = 2 Days, which means the points earned based on the ship date of items in an order are held for two days before they can be used. This hold period introduces a delay between earning the points and being able to redeem them. If a customer places an order on January 1st and the item ships on January 2nd, the points earned from this order would be held until January 4th before they can be used for another purchase.

Order API Use Cases:

  1. Hold Points: Order Item Ship Date = 0 Days https://annexcloud.atlassian.net/wiki/spaces/DOC/pages/2285076586
  2. Hold Points: Order Item Ship Date = 2 Days https://annexcloud.atlassian.net/wiki/spaces/DOC/pages/2286059542
Use Case No. Use Case Description
Use Case 1 Create an Order Create an order with product ID, quantity, and unit price details.
Use Case 2 Partial Ship Some items in an order are shipped.
Use Case 3 Full Ship All items in an order are shipped.
Use Case 4 Partial Return Some items in an order are returned.
Use Case 5 Full Return The entire order is returned.
Use Case 6 Partial Cancel Some items in an order are canceled.
Use Case 7 Full Cancel The entire order is canceled.