The Loyalty Point Entry Redemption object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string
parent_type string
sales_invoice string
redemption_date string
redeemed_points integer
The Loyalty Point Entry Redemption object 
{
  "id": "loyalty-point-entry-redemption_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "sales_invoice": "sales_invoice_example",
  "redemption_date": "2024-01-15",
  "redeemed_points": 0
}
GET /api/accounts/loyalty-point-entry-redemption?parent_id={id}

List loyalty point entry redemptions by parent

Returns all loyalty point entry redemptions belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of loyalty point entry redemption objects belonging to the parent.

GET /api/accounts/loyalty-point-entry-redemption?parent_id={id} 
curl https://api.overplane.dev/api/accounts/loyalty-point-entry-redemption?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "loyalty-point-entry-redemption_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "sales_invoice": "sales_invoice_example",
      "redemption_date": "2024-01-15",
      "redeemed_points": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/loyalty-point-entry-redemption

Create a loyalty point entry redemption

Creates a new loyalty point entry redemption object.

Body parameters

idx integer
parent_id string
parent_type string
sales_invoice string
redemption_date string
redeemed_points integer

Returns

Returns the newly created loyalty point entry redemption object if the call succeeded.

POST /api/accounts/loyalty-point-entry-redemption 
curl https://api.overplane.dev/api/accounts/loyalty-point-entry-redemption \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "loyalty-point-entry-redemption_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "sales_invoice": "sales_invoice_example",
  "redemption_date": "2024-01-15",
  "redeemed_points": 0
}
PATCH /api/accounts/loyalty-point-entry-redemption/{id}

Update a loyalty point entry redemption

Updates the specified loyalty point entry redemption by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the loyalty point entry redemption to update.

Body parameters

idx integer
parent_id string
parent_type string
sales_invoice string
redemption_date string
redeemed_points integer

Returns

Returns the updated loyalty point entry redemption object.

PATCH /api/accounts/loyalty-point-entry-redemption/{id} 
curl https://api.overplane.dev/api/accounts/loyalty-point-entry-redemption/loyalty-point-entry-redemption_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "loyalty-point-entry-redemption_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "sales_invoice": "sales_invoice_example",
  "redemption_date": "2024-01-15",
  "redeemed_points": 0
}
DELETE /api/accounts/loyalty-point-entry-redemption/{id}

Delete a loyalty point entry redemption

Permanently deletes a loyalty point entry redemption. This cannot be undone.

Path parameters

id string required

The identifier of the loyalty point entry redemption to delete.

Returns

Returns a confirmation that the loyalty point entry redemption has been deleted.

DELETE /api/accounts/loyalty-point-entry-redemption/{id} 
curl https://api.overplane.dev/api/accounts/loyalty-point-entry-redemption/loyalty-point-entry-redemption_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "loyalty-point-entry-redemption_abc123",
  "deleted": true
}
POST /api/accounts/loyalty-point-entry-redemption/reorder

Reorder loyalty point entry redemptions

Updates the sort order of loyalty point entry redemptions within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/accounts/loyalty-point-entry-redemption/reorder 
curl https://api.overplane.dev/api/accounts/loyalty-point-entry-redemption/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "loyalty-point-entry-redemption_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "sales_invoice": "sales_invoice_example",
  "redemption_date": "2024-01-15",
  "redeemed_points": 0
}