Hold Points: Order Item Ship Date = 0 Days

Use cases for the hold points type with the order item ship date configured for zero days.

API Use Cases Details

Reports for Use Cases Details

Note: The hold points report is not applicable to the order item ship date configured for zero days. In this configuration, points are awarded immediately upon order placement without any hold period.

Use Case 1: 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-02-04 20:10:10",
    "orderDetail": [
            {
                        "id": "p90",
                        "quantity": "1",
                        "unitPrice": "10"

        },
        {
                        "id": "P91",
                        "quantity": "2",
                        "unitPrice": "200"
        }
                          
    ]
} 

Response

{
    "siteId": "146031180",
    "id": "A1712056419391",
    "userId": "test.order90@gmail.com",
    "orderDate": "2024-02-04T15:10:10+0000",
    "pointsAwarded": 1310,
    "pointsExpirationDate": "2024-05-05T19:59:59+0000",
    "previousTier": "Bronze",
    "updatedUserTier": "Gold Premium",
    "currentTier": "Gold Premium",
    "nextTier": "",
    "pointsToNextTier": 0,
    "currentTierPurchaseRatio": "1.5",
    "spendAmountToNextTier": 0,
    "tierAchievedDate": "2024-04-02T07:13:39+0000",
    "tierExpirationDate": "0000-00-00 00:00:00",
    "orderDetail": [
        {
            "id": "p90",
            "quantity": 1,
            "unitPrice": 10,
            "points": 10
        },
        {
            "id": "P91",
            "quantity": 2,
            "unitPrice": 200,
            "points": 400
        },
        {
            "id": "P92",
            "quantity": 3,
            "unitPrice": 300,
            "points": 900
        }
    ],
    "updatedAvailablePoints": 1320,
    "updatedLifetimePoints": 1320
}

The points for this order will be released immediately, as the configuration specifies zero days for holding points based on the order item ship date.

Activity API

GET: users/{{email_id}}/activity

• In the GET Users Activity related to this order, the point status is “Released”

Order Details API

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

Reports:

Interaction report

• The interaction report displays that 1310 points were released immediately upon completing the purchase action, as per the zero days configuration for the hold points type order item ship date.

Order report

• For the hold points type with the order item ship date configured for zero days, the order report displays 1310 points earned, and 1310 points awarded, with zero points on hold.

Hold Points report

• The hold points report is not applicable to the order item ship date configured for zero days. In this configuration, points are awarded immediately upon order placement without any hold period.

Use Case 2: Partial Ship

In the partial ship use case, we’ll explore a scenario where only a portion of an order is shipped initially. Below are the request and response body schemas for partial shipment of an order.

Request

{
    "orderId": "A1712056419391",
    "status": "ship",
   "orderDetail": [
         {
             "id": "P90",
            "quantity": "1",
            "unitPrice": "10"
        }
                ]
}

Response

{
    "errorCode": "AC1023",
    "errorMessage": "The Order is already shipped."
}

• The response indicates that the order has been shipped.

Activity API

GET: users/{{email_id}}/activity

• In the GET Users Activity API response for the partial ship related to this order displays the point status as “Released”.

Order Details API

• In the order details API, the response displays that points awarded for the order are 1310, with zero points on hold for the partial ship.

Reports:

Interaction report

• The interaction report displays that 1310 points were released immediately upon completing the purchase action, as per the zero days configuration for the hold points type order item ship date.

Order report

• For the hold points type with the order item ship date configured for zero days, the order report displays 1310 points earned, and 1310 points awarded, with zero points on hold.

Hold Points report

• The hold points report is not applicable to the order item ship date configured for zero days. In this configuration, points are awarded immediately upon order placement without any hold period.

Use Case 3: Full Ship

In the full ship use case, we will explore a scenario where all products in an order are shipped. Below are the request and response body schemas for full shipment of an order.

Request

{
    "orderId" : "A1712056419391",
    "status": "ship"
}

Response

{
    "errorCode": "AC1023",
    "errorMessage": "The Order is already shipped."
}

• The response indicates that the order has been shipped.

Activity API

GET: users/{{email_id}}/activity

• In the GET Users Activity API response for the full ship related to this order displays the point status as “Released”.

Order Details API

• In the order details API, the response displays that points awarded for the order are 1310, with zero points on hold for the full ship.

Reports:

Interaction report

• The interaction report for the full ship displays 1310 points released for the hold points type order item ship date configured for zero days.

Order report

The order report for full ship displays 1310 points earned and 1310 points awarded, with zero points on hold for the hold points type with the order item ship date configured for zero days.

Hold Points report

• The hold points report is not applicable to the order item ship date configured for zero days. In this configuration, points are awarded immediately upon order placement without any hold period.

Use Case 4: Partial Return

In the partial return use case, we will explore a scenario where one of the products from the order is partially returned. Below are the request and response body schemas for partial return of an order.

Request

{
    "orderId": "A1712056419391",
    "status": "return",
    "orderDetail": [
        {
            "id": "p90",
            "quantity": "1",
            "unitPrice": "10"
        }
        ],
    "reason": "credit memo"
}

Response

{
    "siteId": "146031180",
    "orderId": "A1712056419391",
    "pointsRemoved": 10,
    "updatedAvailablePoints": 1310,
    "updatedLifetimePoints": 1320,
    "previousTier": "Bronze",
    "updatedUserTier": "",
    "currentTier": "Gold Premium",
    "nextTier": "",
    "pointsToNextTier": 0,
    "currentTierPurchaseRatio": "1.5",
    "spendAmountToNextTier": 0,
    "tierAchievedDate": "2024-04-02T07:13:39+0000",
    "tierExpirationDate": "0000-00-00 00:00:00",
    "reason": "credit memo"
}

• The response for the partial return displays that 10 points were deducted for the partial return of an order.

Activity API

GET: users/{{email_id}}/activity

• In the GET Users Activity API response for the partial return related to this order displays return of the product from this order, showing that the activity is debit, with 10 points debited.

Order Details API

• In the order details API response, it displays that 1300 points were awarded with zero points on hold for the partial return.

Reports:

Interaction report

• The interaction report for the partial return displays points as -10 with the action as return.

Order report

• The order report for partial return displays 1310 points earned, 1300 points awarded, with zero points on hold.

Hold Points report

• The hold points report is not applicable to the order item ship date configured for zero days. In this configuration, points are awarded immediately upon order placement without any hold period.

Use Case 5: Full Return

In the full return use case, we will explore a scenario where all the products in the order are returned. Below are the request and response body schemas for full return of an order.

Request

{
        "orderId": "A1713763666536",
        "status": "return"
}

Response

{
    "siteId": "146031180",
    "orderId": "A1713763666536",
    "pointsRemoved": 1310,
    "updatedAvailablePoints": 0,
    "updatedLifetimePoints": 1310,
    "previousTier": "Gold Premium",
    "updatedUserTier": "Bronze",
    "currentTier": "Bronze",
    "nextTier": "Silver Premium",
    "pointsToNextTier": 101,
    "currentTierPurchaseRatio": "1",
    "spendAmountToNextTier": 0,
    "tierAchievedDate": "2024-04-22T01:28:40+0000",
    "tierExpirationDate": "0000-00-00 00:00:00"
}

• The response for the full return displays that 1310 points are deducted due to the full return of the order.

Activity API

GET: users/{{email_id}}/activity

• In the GET Users Activity API response for the full return related to this order, displays return where the activity is debit, with 1310 points debited.

Order Details API

• In the order details API response, it displays that zero points were awarded and zero points are on hold.

Reports:

Interaction report

• The interaction report for the full return displays points as -1310 with the action as return.

Order report

• The order report for the full return displays 1310 points were earned, with zero points awarded and zero points on hold.

Hold Points report

• The hold points report is not applicable to the order item ship date configured for zero days. In this configuration, points are awarded immediately upon order placement without any hold period.

Use Case 6: Partial Cancel

In the partial cancel use case, we will explore a scenario where a single product in the order is cancelled. Below are the request and response body schemas for partial cancel of an order.

Request

{
    "orderId": "A1712122646370",
    "status": "cancel",
    "orderDetail": [
        {
            "id": "p80",
            "quantity": "1",
            "unitPrice": "10"
            
            
        }
        ]
}

Response

{
    "errorCode": "AC1023",
    "errorMessage": "The Order is already shipped."
}

• The response indicates that the order has been shipped.

Activity API

GET: users/{{email_id}}/activity

• In the GET Users Activity API response for the partial cancel related to this order displays the point status as “Released”.

Order Details API

• In the order details API, the response displays that points awarded for the order are 1310, with zero points on hold for the partial cancel.

Reports:

Interaction report

• The interaction report for the partial cancel displays 1310 points released for the hold points type order item ship date configured for zero days.

Order report

• The order report for partial cancel displays 1310 points earned and 1310 points awarded, with zero points on hold.

Hold Points report

• The hold points report is not applicable to the order item ship date configured for zero days. In this configuration, points are awarded immediately upon order placement without any hold period.

Use Case 7: Full Cancel

In the full cancel use case, we will explore a scenario where the entire order is cancelled. Below are the request and response body schemas for full cancel of an order.

Request

{
    "orderId" : "A1712122646370",
    "status": "cancel"
}

Response

{
    "errorCode": "AC1023",
    "errorMessage": "The Order is already shipped."
}

• The response indicates that the order has been shipped.

Activity API

GET: users/{{email_id}}/activity

• In the GET Users Activity API response for the full cancel related to this order displays the point status as “Released”.

Order Details API

• In the order details API, the response displays that points awarded for the order are 1310, with zero points on hold for the full cancel.

Reports:

Interaction report

• The interaction report for the full cancel displays 1310 points released for the hold points type order item ship date configured for zero days.

Order report

• The order report for full cancel displays 1310 points earned and 1310 points awarded, with zero points on hold.

Hold Points report

• The hold points report is not applicable to the order item ship date configured for zero days. In this configuration, points are awarded immediately upon order placement without any hold period.