Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yuko.so/llms.txt

Use this file to discover all available pages before exploring further.

fRetrieves a single points transaction by ID. GET / points_transactions / - Try it

Authorizations

Authorization string header required Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id integer required ID of the points transaction to retrieve.

Response

200 - application/json The points transaction was successfully retrieved. points_transaction object Hide child attributes points_transaction.id integer Unique identifier for the points transaction. Example: 825673452 points_transaction.customer_id integer The ID of the customer whose balance this points transaction applies to. Example: 304169228 points_transaction.points_change integer The number of points added or removed from the customer’s points balance. The value is positive if points were added to the customer’s balance and negative if points were deducted. Example: 100 points_transaction.description string A message visible to the customer that describes the reason for the points change. Example: "Points correction" points_transaction.internal_note string | null A note that is visible to the merchant. This note should never be visible to customers. Example: "Due to issue with order #6834" points_transaction.created_at string<date-time> The date and time when the points transaction was created. Example: "2024-12-07T20:15:27.893Z" points_transaction.updated_at string<date-time> The date and time when the points transaction was last updated. Example: "2024-12-07T20:15:27.893Z"