square-connect-openapi-agent/skills/loyalty/SKILL.md

name, description

name	description
loyalty-routes	Handle 18 OpenAPI operation(s) under /v2/loyalty for the loyalty route group.

loyalty API Routes

Handle 18 OpenAPI operation(s) under /v2/loyalty for the loyalty route group.

Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.

Operations

create_loyalty_account

• Operation ID: create_loyalty_account
• Route: POST /v2/loyalty/accounts
• Mode: WRITE
• Summary: CreateLoyaltyAccount
• Body: JSON request body accepted.

search_loyalty_accounts

• Operation ID: search_loyalty_accounts
• Route: POST /v2/loyalty/accounts/search
• Mode: WRITE
• Summary: SearchLoyaltyAccounts
• Body: JSON request body accepted.

retrieve_loyalty_account

• Operation ID: retrieve_loyalty_account
• Route: GET /v2/loyalty/accounts/{account_id}
• Mode: READ
• Summary: RetrieveLoyaltyAccount
• Parameters:
  • account_id in path required

accumulate_loyalty_points

• Operation ID: accumulate_loyalty_points
• Route: POST /v2/loyalty/accounts/{account_id}/accumulate
• Mode: WRITE
• Summary: AccumulateLoyaltyPoints
• Parameters:
  • account_id in path required
• Body: JSON request body accepted.

adjust_loyalty_points

• Operation ID: adjust_loyalty_points
• Route: POST /v2/loyalty/accounts/{account_id}/adjust
• Mode: WRITE
• Summary: AdjustLoyaltyPoints
• Parameters:
  • account_id in path required
• Body: JSON request body accepted.

search_loyalty_events

• Operation ID: search_loyalty_events
• Route: POST /v2/loyalty/events/search
• Mode: WRITE
• Summary: SearchLoyaltyEvents
• Body: JSON request body accepted.

list_loyalty_programs

• Operation ID: list_loyalty_programs
• Route: GET /v2/loyalty/programs
• Mode: READ
• Summary: ListLoyaltyPrograms

retrieve_loyalty_program

• Operation ID: retrieve_loyalty_program
• Route: GET /v2/loyalty/programs/{program_id}
• Mode: READ
• Summary: RetrieveLoyaltyProgram
• Parameters:
  • program_id in path required

calculate_loyalty_points

• Operation ID: calculate_loyalty_points
• Route: POST /v2/loyalty/programs/{program_id}/calculate
• Mode: WRITE
• Summary: CalculateLoyaltyPoints
• Parameters:
  • program_id in path required
• Body: JSON request body accepted.

list_loyalty_promotions

• Operation ID: list_loyalty_promotions
• Route: GET /v2/loyalty/programs/{program_id}/promotions
• Mode: READ
• Summary: ListLoyaltyPromotions
• Parameters:
  • program_id in path required
  • status in query
  • cursor in query
  • limit in query

create_loyalty_promotion

• Operation ID: create_loyalty_promotion
• Route: POST /v2/loyalty/programs/{program_id}/promotions
• Mode: WRITE
• Summary: CreateLoyaltyPromotion
• Parameters:
  • program_id in path required
• Body: JSON request body accepted.

retrieve_loyalty_promotion

• Operation ID: retrieve_loyalty_promotion
• Route: GET /v2/loyalty/programs/{program_id}/promotions/{promotion_id}
• Mode: READ
• Summary: RetrieveLoyaltyPromotion
• Parameters:
  • promotion_id in path required
  • program_id in path required

cancel_loyalty_promotion

• Operation ID: cancel_loyalty_promotion
• Route: POST /v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel
• Mode: WRITE
• Summary: CancelLoyaltyPromotion
• Parameters:
  • promotion_id in path required
  • program_id in path required

create_loyalty_reward

• Operation ID: create_loyalty_reward
• Route: POST /v2/loyalty/rewards
• Mode: WRITE
• Summary: CreateLoyaltyReward
• Body: JSON request body accepted.

search_loyalty_rewards

• Operation ID: search_loyalty_rewards
• Route: POST /v2/loyalty/rewards/search
• Mode: WRITE
• Summary: SearchLoyaltyRewards
• Body: JSON request body accepted.

delete_loyalty_reward

• Operation ID: delete_loyalty_reward
• Route: DELETE /v2/loyalty/rewards/{reward_id}
• Mode: WRITE
• Summary: DeleteLoyaltyReward
• Parameters:
  • reward_id in path required

retrieve_loyalty_reward

• Operation ID: retrieve_loyalty_reward
• Route: GET /v2/loyalty/rewards/{reward_id}
• Mode: READ
• Summary: RetrieveLoyaltyReward
• Parameters:
  • reward_id in path required

redeem_loyalty_reward

• Operation ID: redeem_loyalty_reward
• Route: POST /v2/loyalty/rewards/{reward_id}/redeem
• Mode: WRITE
• Summary: RedeemLoyaltyReward
• Parameters:
  • reward_id in path required
• Body: JSON request body accepted.