Skip to content

AC-16602: Customer Balance API Documentation#537

Open
shashi011 wants to merge 1 commit intoAdobeDocs:mainfrom
shashi011:AC-16602
Open

AC-16602: Customer Balance API Documentation#537
shashi011 wants to merge 1 commit intoAdobeDocs:mainfrom
shashi011:AC-16602

Conversation

@shashi011
Copy link
Copy Markdown

@shashi011 shashi011 commented Mar 13, 2026

Purpose of this pull request

Added API documentation for the new REST endpoint introduced to support Customer Balance Admin functionality.
JIRA Ticket : https://jira.corp.adobe.com/browse/AC-16410

Affected pages

  • ...

Links to Magento Open Source code

  • ...

@shashi011
Copy link
Copy Markdown
Author

@keharper
Please review the following new REST API endpoints added to the Admin API schema (Commerce 2.4.8):
Endpoints:
POST /V1/carts/{cartId}/balance/apply - Apply store credit balance to a cart
DELETE /V1/carts/{cartId}/balance/unapply - Unapply store credit balance from a cart
GET /V1/customers/{customerId}/balance/{websiteId} - Get store credit balance for a customer and website
Changes:
Added endpoint definitions, tags, and tag groups
Created schema definition: customer-balance-data-balance-interface
File: src/openapi/admin-schema-2.4.8.yaml
Please review for correctness and consistency with existing API patterns. Also, please confirm if we need to update any other files or documentation for these REST changes. Thanks!

@shashi011 shashi011 marked this pull request as ready for review March 23, 2026 08:56
@shashi011 shashi011 marked this pull request as draft March 24, 2026 06:34
@shashi011 shashi011 changed the title AC-16602: API Documentation AC-16602: Customer Balance API Documentation Mar 24, 2026
@shashi011
Copy link
Copy Markdown
Author

hi @keharper
Just wanted to gently follow up on my previous PR for the new Admin API REST endpoints for Customer Balance (Commerce 2.4.8). Whenever you have some time, I’d really appreciate it if you could review it and share your feedback on correctness and alignment with existing API patterns. Also, please let me know if any additional updates (docs or other files) are needed.

@shashi011 shashi011 marked this pull request as ready for review March 27, 2026 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 📋 Needs Review

Development

Successfully merging this pull request may close these issues.

2 participants