Skip to content

refactor(b2b): split Master Data into dedicated B2B API specs#1585

Merged
PedroAntunesCosta merged 11 commits intomasterfrom
docs/masterdata-b2b-changes
Jan 27, 2026
Merged

refactor(b2b): split Master Data into dedicated B2B API specs#1585
PedroAntunesCosta merged 11 commits intomasterfrom
docs/masterdata-b2b-changes

Conversation

@PedroAntunesCosta
Copy link
Copy Markdown
Contributor

@PedroAntunesCosta PedroAntunesCosta commented Jan 22, 2026

Summary

Improve the architecture of B2B-related APIs by migrating endpoints from Master Data specs into dedicated, focused API specification files.

Main Change

Migrated B2B endpoints from Master Data specs into their own dedicated OpenAPI files:

New Spec Migrated From
VTEX - B2B Contracts API.json VTEX - MasterData API - v10.2.json
VTEX - B2B Contact Information API.json VTEX - MasterData API - v10.2.json
VTEX - B2B Buyer Data API.json VTEX - Master Data API - v2.json

Additional Changes (opportunistic)

  • Add addressLabel to AD create/update request schema in MasterData v10.2
  • Merge duplicated AD address endpoints to {addressId} and consolidate request/response schemas

Why

  • Better separation of concerns for B2B APIs
  • Easier discoverability and maintenance of B2B-related endpoints
  • Cleaner, more focused API surface for each domain

@PedroAntunesCosta PedroAntunesCosta self-assigned this Jan 22, 2026
@github-actions
Copy link
Copy Markdown

Thanks for your contribution. The .json file will be checked now with Spectral.

@PedroAntunesCosta PedroAntunesCosta changed the title docs(masterdata): b2b schema updates docs(masterdata): b2b schema updates + address path merge Jan 23, 2026
@PedroAntunesCosta PedroAntunesCosta changed the title docs(masterdata): b2b schema updates + address path merge refactor(b2b): split Master Data into dedicated B2B API specs Jan 26, 2026
@PedroAntunesCosta PedroAntunesCosta requested a review from a team January 26, 2026 16:24
- Update POST /documents to return 201 Created and 202 Accepted
- Change PUT /documents/{id} to return 204 No Content
- Update PATCH /documents to return 200 OK with response body
- Change PATCH /documents/{id} to return 204 No Content
- Change DELETE /documents/{id} to return 204 No Content
- Apply same fixes to B2B Contact Information API
ricardoaerobr
ricardoaerobr previously approved these changes Jan 27, 2026
Copy link
Copy Markdown
Contributor

@ricardoaerobr ricardoaerobr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

- Fix spectral linting issues in B2B Contracts API
- Fix spectral linting issues in B2B Buyer Data API
- Fix spectral linting issues in Master Data API v2
- Fix spectral linting issues in MasterData API v10.2
Copy link
Copy Markdown
Contributor

@ricardoaerobr ricardoaerobr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@PedroAntunesCosta PedroAntunesCosta merged commit 91aa4e2 into master Jan 27, 2026
2 of 3 checks passed
@PedroAntunesCosta PedroAntunesCosta deleted the docs/masterdata-b2b-changes branch January 27, 2026 16:37
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