fix(vtex): add searchField companion query params to List Orders#454
Merged
Conversation
Use schema override from fork while waiting for upstream PR vtex/openapi-schemas#1728 to be merged. Adds the 6 companion query parameters (sku_Ids, listId, tid, pci_tid, paymentId, nsu) that are required alongside searchField for order filtering. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
download-schemas.tsto pull the Orders API schema from a fork with the fix, while waiting for vtex/openapi-schemas#1728 to be merged upstreamsearchFieldas an enum (sku_Ids,listId,tid,pci_tid,paymentId,nsu) instead of free-form stringTest plan
bun testpasses (77 tests, 0 failures)VTEX_LIST_ORDERStool exposes the new parameters🤖 Generated with Claude Code
Summary by cubic
Fixes VTEX Orders “List Orders” filtering by making
searchFielda strict enum and adding the required companion query params. Regenerates the SDK/types/zod using a temporary schema override until the upstream schema fix is merged.Bug Fixes
List Orders:searchFieldis now an enum (sku_Ids,listId,tid,pci_tid,paymentId,nsu) with matching query params added (sku_Ids,listId,tid,pci_tid,paymentId,nsu).vtex/scripts/download-schemas.tsto pull the corrected Orders schema from a fork while the upstream PR is pending.Migration
List Orders, use one of the allowedsearchFieldvalues and include its matching parameter (e.g.,searchField=sku_Ids&sku_Ids=11223).Written for commit 436ade4. Summary will update on new commits.