S
SquareupApi
Arcade Native

AccumulateLoyaltyPoints

SquareupApi.AccumulateLoyaltyPoints

Arcade Native Built and maintained by Arcade with full support
Supported by Arcade

Description

Add points to a loyalty account for a purchase.

This tool adds loyalty points to a customer's account following a purchase. It can be used with or without the Orders API. If using the Orders API, provide the `order_id` for automatic point calculation based on the program and promotions. If not, manually compute and provide the `points` to add.

Input Parameters

{
  "parameters": [
    {
      "name": "loyalty_account_id",
      "required": true,
      "inferrable": true,
      "description": "The unique identifier for the target loyalty account to which points will be added.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "purchase_location_id",
      "required": true,
      "inferrable": true,
      "description": "The ID of the location where the purchase was made, necessary for loyalty point accumulation.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "unique_request_id",
      "required": true,
      "inferrable": true,
      "description": "A unique string identifier for the `AccumulateLoyaltyPoints` request. Must be unique for each request to ensure idempotency.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "loyalty_program_id",
      "required": false,
      "inferrable": true,
      "description": "The ID of the loyalty program to add points to. Required to identify the correct program.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "order_id_for_accumulation",
      "required": false,
      "inferrable": true,
      "description": "The ID of the order for which points are accumulated. Required if using the Orders API.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "points_to_accumulate",
      "required": false,
      "inferrable": true,
      "description": "Specify the number of points to add to the loyalty account from the purchase event if not using the Orders API.",
      "value_schema": {
        "val_type": "integer"
      }
    }
  ]
}

Output

{
  "description": "Response from the API endpoint 'AccumulateLoyaltyPoints'.",
  "value_schema": {
    "val_type": "json"
  },
  "available_modes": [
    "value",
    "error"
  ]
}