Skip to content

Add Customer private-note endpoint - #218

Closed
PrestaEdit wants to merge 1 commit into
PrestaShop:devfrom
PrestaEdit:add-customer-private-note-endpoint
Closed

PrestaEdit wants to merge 1 commit into
PrestaShop:devfrom
PrestaEdit:add-customer-private-note-endpoint

Conversation

@PrestaEdit

@PrestaEdit PrestaEdit commented Jun 11, 2026 •

Copy link
Copy Markdown
Contributor
Questions Answers
Description? Add a Customer private-note endpoint to the Admin API
Type? new feature
BC breaks? no
Deprecations? no
Fixed ticket? Related to PrestaShop/PrestaShop#39630
Sponsor company

Exposes SetPrivateNoteAboutCustomerCommand through
PATCH /customers/{customerId}/private-notes, in a dedicated resource class so the
rich Customer resource is left untouched. The body carries the privateNote string
(mapped by matching field name). The URI uses the plural private-notes to satisfy the
module's ApiResourceUriTemplateRector convention.

Adds an integration test and a scopes (authorization) entry.

@github-project-automation github-project-automation Bot moved this to Ready for review in PR Dashboard Jun 11, 2026
Expose SetPrivateNoteAboutCustomerCommand through
PATCH /customers/{customerId}/private-note, in a dedicated resource class so
the rich Customer resource is left untouched. The body carries the privateNote
string (mapped by matching field name).

Adds an integration test and a scopes entry.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@PrestaEdit

Copy link
Copy Markdown
Contributor Author

Superseded by #428, which merges this endpoint with the rest of the domain, following the mutualisation asked for by the core team (one PR per domain rather than one per endpoint).

The consolidated PR is green and lists what changed for this endpoint on the way in. Closing here to keep the review in one place.

@PrestaEdit PrestaEdit closed this Aug 20, 2026
@github-project-automation github-project-automation Bot moved this from Ready for review to Closed in PR Dashboard Aug 20, 2026
@ps-jarvis ps-jarvis moved this from Closed to Ready for review in PR Dashboard Aug 20, 2026
mattgoud pushed a commit to PrestaEdit/ps_apiresources that referenced this pull request Sep 23, 2026
Consolidates PrestaShop#218, PrestaShop#225, PrestaShop#243 and PrestaShop#342.

PrestaShop#218 and PrestaShop#225 both wrote CustomerEndpointTest.php and conflict on cherry-pick, which
is the usual sign that they belonged in one PR.

PrestaShop#342 is dropped rather than merged. It exposed GetCustomerForAddressCreation as
GET /customers/address-creation-infos?customerEmail=, but that query is already
listed in EXCLUDED_CQRS_CLASSES on dev with the USELESS_DUPLICATE reason — and the
exclusion is right: GET /customers/search matches on email among other fields and
returns idCustomer, firstname, lastname and company, a strict superset of the four
fields the dropped endpoint returned. The exclusion entry already exists, so this PR
adds nothing for it.

The private-note test now asserts its work: the note is the privateNote of the
generalInformation of GET /customers/{customerId}/details, so the write finally has a
read side to check against. It previously asserted the 204 and nothing else.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants