Hold Points: Order Item Ship Date = 2 Days

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

API Use Cases Details

Reports for Use Cases Details

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-04-29 20:10:10",
    "orderDetail": [
        {
            "id": "P31",
            "quantity": "1",
            "unitPrice": "10"
        },
        {
            "id": "P32",
            "quantity": "2",
            "unitPrice": "20"
},
        {
            "id": "P33",
            "quantity": "3",
            "unitPrice": "30"
        }
    ]
}

Response

{
    "siteId": "146031180",
    "id": "A1714369831739",
    "userId": "bh901@gmail.com",
    "orderDate": "2024-04-29T16:10:10+0000",
    "pointsAwarded": 0,
    "pointsExpirationDate": "",
    "pointsOnHold": 140,
    "previousTier": "",
    "updatedUserTier": "",
    "currentTier": "Bronze",
    "nextTier": "Silver Premium",
    "pointsToNextTier": 101,
    "currentTierPurchaseRatio": "1",
    "spendAmountToNextTier": 0,
    "tierAchievedDate": "2024-04-29T01:17:19+0000",
    "tierExpirationDate": "0000-00-00 00:00:00",
    "orderDetail": [
        {
            "id": "P31",
            "quantity": 1,
            "unitPrice": 10,
            "points": 10
        },
        {
            "id": "P32",
            "quantity": 2,
            "unitPrice": 20,
            "points": 40
        },
        {
            "id": "P33",
            "quantity": 3,
            "unitPrice": 30,
            "points": 90
        }
    ],
    "updatedAvailablePoints": 0,
    "updatedLifetimePoints": 0
}

• The points awarded for this order is zero, as the order item ship date for the hold points type is configured for 2 days, so the points 140 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 140.

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 order item ship date is configured for 2 days for the purchase action.

Order report

• The order report for the hold points type with the order item ship date configured for 2 days displays that 140 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 140 points are on hold.

Hold Points report-2nd level

• The second-level hold points report for this order ID displays that the status for the three products in this order is On Hold.

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": "A1714369831739",
    "status": "ship",
   "orderDetail": [
         {
             "id": "P31",
            "quantity": "1",
            "unitPrice": "10"
        }
   ]
}

Response

{
    "siteId": "146031180",
    "orderId": "A1714369831739",
    "pointsAwarded": 0,
    "currentReleasedPoints": 0,
    "pointsExpirationDate": "",
    "pointsOnHold": 140,
    "updatedAvailablePoints": 0,
    "updatedLifetimePoints": 0,
    "previousTier": "",
    "updatedUserTier": "",
    "orderDetail": [
        {
            "id": "P31",
            "quantity": 1,
            "unitPrice": 10,
            "points": 10
        }
    ],
    "currentTier": "Bronze",
    "nextTier": "Silver Premium",
    "pointsToNextTier": 101,
    "currentTierPurchaseRatio": "1",
    "spendAmountToNextTier": 0,
    "tierAchievedDate": "2024-04-29T01:17:19+0000",
    "tierExpirationDate": "0000-00-00 00:00:00"
}

• The response indicates that the points awarded are zero and the points on hold are 140.

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 140.

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 order item ship date is configured for 2 days for the purchase action.

Order report

• The order report for the hold points type with the order item ship date configured for 2 days displays that 140 points are on hold, zero points are earned, and zero points are awarded.

Hold Points report

• The hold points report for this partial ship shows that 140 points are on hold.

Hold Points report-2nd level

• The second-level hold points report for the partial shipment of this order displays that the status of the shipped product is Partially on Hold, along with the release date of the points.

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" : "A1714374089345",
    "status": "ship"
}

Response

{
    "siteId": "146031180",
    "orderId": "A1714374089345",
    "pointsAwarded": 0,
    "pointsExpirationDate": "",
    "pointsOnHold": 140,
    "updatedAvailablePoints": 0,
    "updatedLifetimePoints": 0,
    "previousTier": "",
    "updatedUserTier": "",
    "currentTier": "Bronze",
    "nextTier": "Silver Premium",
    "pointsToNextTier": 101,
    "currentTierPurchaseRatio": "1",
    "spendAmountToNextTier": 0,
    "tierAchievedDate": "2024-04-29T03:01:17+0000",
    "tierExpirationDate": "0000-00-00 00:00:00"
}

• The response indicates that the points awarded are zero and the points on hold are 140.

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 140.

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 order item ship date is configured for 2 days for the purchase action.

Order report

• The order report for the hold points type with the order item ship date configured for 2 days displays that 140 points are on hold, zero points are earned, and zero points are awarded.

Hold Points report

• The hold points report for this full ship shows that 140 points are on hold, along with the release date of the points.

Hold Points report-2nd level

• The second-level hold points report for the full shipment of this order displays that the status of all the shipped products is Partially on Hold, along with the release date of the points.

Use Case 4: Partial Return Before Full Ship

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

Request

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

Response

{
    "errorCode": "AC1024",
    "errorMessage": "The Order must be shipped before return."
}

• The response for the partial return before full ship displays that the order must be shipped before return.

Activity API

GET: users/{{email_id}}/activity

• In the GET Users Activity API response for the partial return before full ship related to this order the point status displayed as “Hold”.

Order Details API

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

Reports:

Interaction report

• The interaction report for the partial return displays points as zero with the action as purchase.

Order report

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

Hold Points report

• The hold points report displays 140 points on hold for the partial return before full ship with the action as purchase.

Hold Points report-2nd level

• The second-level hold points report for this order ID displays that the status for the three products in this order is On Hold.

Use Case 5: Full Return Before Full Ship

In the full return before full ship 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": "A1714381572869",
        "status": "return"
}

Response

{
    "errorCode": "AC1024",
    "errorMessage": "The Order must be shipped before return."
}

• The response for the full return displays that the order must be shipped before return.

Activity API

GET: users/{{email_id}}/activity

• In the GET Users Activity API response for the full return related to this order, displays point status as hold where the activity is credit, with 140 points credited.

Order Details API

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

Reports:

Interaction report

• The interaction report for the full return displays zero points with the action as purchase.

Order report

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

Hold Points report

• The hold points report displays 140 points on hold with the action as purchase for the full return of this order.

Hold Points report-2nd level

• The second-level hold points report for this order ID displays that the status for the three products in this order is On Hold.

Use Case 6: Partial Return After Full Ship

In the partial return after full ship 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": "A1714384517065",
        "status": "return",
        "orderDetail": [
        {
            "id": "P86",
            "quantity": "1",
            "unitPrice": "10"
        }
        ]
}

Response

{
    "siteId": "146031180",
    "orderId": "A1714384517065",
    "pointsRemoved": 0,
    "pointsOnHold": 130,
    "updatedAvailablePoints": 0,
    "updatedLifetimePoints": 0,
    "previousTier": "",
    "updatedUserTier": "",
    "currentTier": "Bronze",
    "nextTier": "Silver Premium",
    "pointsToNextTier": 101,
    "currentTierPurchaseRatio": "1",
    "spendAmountToNextTier": 0,
    "tierAchievedDate": "2024-04-29T05:54:55+0000",
    "tierExpirationDate": "0000-00-00 00:00:00"
}

• The response for the partial return displays that zero points were deducted and 130 points are on hold 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 zero points debited.

Order Details API

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

Reports:

Interaction report

• The interaction report for the partial return displays zero points with the action as purchase.

Order report

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

Hold Points report

• The hold points report displays 130 points on hold for the partial return of the order.

Hold Points report-2nd level

• The second-level hold points report for the partial return of this order displays that the status of the products which are not cancelled is on hold, along with the release date of the points.

Use Case 7: Full Return After Full Ship

In the full return after full ship 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": "A1714386761129",
        "status": "return"
}

Response

{
    "siteId": "146031180",
    "orderId": "A1714386761129",
    "pointsRemoved": 0,
    "pointsOnHold": 0,
    "updatedAvailablePoints": 0,
    "updatedLifetimePoints": 0,
    "previousTier": "",
    "updatedUserTier": "",
    "currentTier": "Bronze",
    "nextTier": "Silver Premium",
    "pointsToNextTier": 101,
    "currentTierPurchaseRatio": "1",
    "spendAmountToNextTier": 0,
    "tierAchievedDate": "2024-04-29T06:31:58+0000",
    "tierExpirationDate": "0000-00-00 00:00:00"
}

• The response for the full return displays that zero points are deducted.

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 zero 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 zero points.

Order report

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

Hold Points report

• The hold points report shows no data for the full return of this configuration as there are zero points on hold.

Use Case 8: 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": "A1714388211968",
        "status": "cancel",
        "orderDetail": [
        {
            "id": "P37",
            "quantity": "1",
            "unitPrice": "10"
            
        }
        ]
}

Response

{
    "siteId": "146031180",
    "orderId": "A1714388211968",
    "pointsRemoved": 10,
    "pointsOnHold": 130,
    "updatedAvailablePoints": 0,
    "updatedLifetimePoints": 0,
    "previousTier": "",
    "updatedUserTier": "",
    "currentTier": "Bronze",
    "nextTier": "Silver Premium",
    "pointsToNextTier": 101,
    "currentTierPurchaseRatio": "1",
    "spendAmountToNextTier": 0,
    "tierAchievedDate": "2024-04-29T06:56:36+0000",
    "tierExpirationDate": "0000-00-00 00:00:00"
}

• The response displays that 10 points are deducted for partial cancel and 130 points are on hold.

Activity API

GET: users/{{email_id}}/activity

• In the GET Users Activity related to this order, the point status is “Hold”, with the activity as credit.

Order Details API

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

Reports:

Interaction report

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

Order report

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

Hold Points report

• The hold points report for this partial cancel shows that 130 points are on hold.

Hold Points report-2nd level

• The second-level hold points report for the partial cancel of this order displays that the status of the products which are not cancelled is On Hold.

Use Case 9: 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" : "A1714390926142",
        "status": "cancel"
}

Response

{
    "siteId": "146031180",
    "orderId": "A1714390926142",
    "pointsRemoved": 140,
    "pointsOnHold": 0,
    "updatedAvailablePoints": 0,
    "updatedLifetimePoints": 0,
    "previousTier": "",
    "updatedUserTier": "",
    "currentTier": "Bronze",
    "nextTier": "Silver Premium",
    "pointsToNextTier": 101,
    "currentTierPurchaseRatio": "1",
    "spendAmountToNextTier": 0,
    "tierAchievedDate": "2024-04-29T07:41:48+0000",
    "tierExpirationDate": "0000-00-00 00:00:00"
}

• The response displays that 140 points are deducted for full cancel and zero points are on hold.

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 cancelled with the activity as debit.

Order Details API

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

Reports:

Interaction report

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

Order report

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

Hold Points report

• The hold points report shows no data for the full cancel of this configuration as there are zero points on hold.