Skip to content

Fix: Document searchField enum and companion query parameters in List Orders#1728

Open
guitavano wants to merge 1 commit into
vtex:masterfrom
guitavano:fix/list-orders-search-field-params
Open

Fix: Document searchField enum and companion query parameters in List Orders#1728
guitavano wants to merge 1 commit into
vtex:masterfrom
guitavano:fix/list-orders-search-field-params

Conversation

@guitavano

Copy link
Copy Markdown

Summary

  • Changed searchField from a free-form string to an enum with the 6 valid values: sku_Ids, listId, tid, pci_tid, paymentId, nsu.
  • Added the 6 companion query parameters (sku_Ids, listId, tid, pci_tid, paymentId, nsu) that were missing from the schema.

Why

The searchField parameter requires a companion query parameter to provide the actual search value. For example:

/api/oms/pvt/orders?searchField=sku_Ids&sku_Ids=11223

Previously, only searchField was documented (as a free string), so code generation tools and SDK clients had no way to know about the companion parameters like sku_Ids. This made it impossible to use this feature correctly via generated clients.

Test plan

  • Validate the OpenAPI schema is valid JSON
  • Confirm the enum values match the API behavior
  • Verify generated SDK clients now expose all search parameters

🤖 Generated with Claude Code

… Orders

The searchField parameter was documented as a free-form string, but it
actually accepts a fixed set of values (sku_Ids, listId, tid, pci_tid,
paymentId, nsu). Additionally, each searchField value requires a
companion query parameter (e.g. searchField=sku_Ids&sku_Ids=11223)
that was not listed in the schema, making it invisible to code
generation tools and SDK clients.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
guitavano added a commit to decocms/mcps that referenced this pull request Jun 18, 2026
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants