Added new pages for Company address book mutations - #586
Merged
Conversation
keharper
reviewed
Jul 31, 2026
Clarified the update process for company addresses, including conditions for `company_id` and `type` fields.
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
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.
Purpose of this pull request
Documents the company address book feature exposed by the B2B Storefront Compatibility Package end-to-end — GraphQL, REST, and their integration points on the cart and core Company APIs:
GraphQL mutations for company address CRUD (createCompanyAddress, updateCompanyAddress, deleteCompanyAddress, setDefaultCompanyAddress), plus reading defaults back from the Company query.
Cart address mutations (setBillingAddressOnCart, setShippingAddressesOnCart) updated with examples showing both the standard customer address book path (customer_address_uid) and the new B2B company address book path (company_address_id).
REST equivalents of the four company address CRUD mutations, sourced from the CompanyAddressStorefrontCompatibilityRest module (webapi.xml, acl.xml, data interfaces, and API test fixtures) — documenting required ACL resources, request/response payloads, and validation behavior.
REST company object docs updated to document the two new CompanyInterface extension attributes (is_company_address_book_enabled, is_custom_shipping_address_allowed) that gate the feature, including the non-obvious cascade rule where disabling the address book forces custom shipping addresses off.
Site navigation fixes so all of the above are actually discoverable in the left nav, which previously omitted both the GraphQL mutations and the new REST pages.
Affected pages
GraphQL (src/pages/graphql/schema/)
b2b/company/mutations/create-address.md — createCompanyAddress mutation
b2b/company/mutations/update-address.md — updateCompanyAddress mutation
b2b/company/mutations/delete-address.md — deleteCompanyAddress mutation
b2b/company/mutations/set-default-address.md — setDefaultCompanyAddress mutation
b2b/company/mutations/index.md — added "Company Address Book mutations" summary section
b2b/company/queries/company.md — documents default_billing_address / default_shipping_address on the Company type
cart/mutations/set-billing-address.md — added examples assigning an existing customer address (customer_address_uid) and a company address (company_address_id)
cart/mutations/set-shipping-address.md — same two examples for shipping
REST (src/pages/rest/b2b/)
create-address.md — POST /V1/company/:companyId/address
update-address.md — PUT /V1/company-address/:addressId
delete-address.md — DELETE /V1/company-address/:addressId
set-default-address.md — PUT /V1/company-addresses/:addressId/default
company.md — added the four new pages to "Related information"
company-object.md — added the is_company_address_book_enabled / is_custom_shipping_address_allowed extension attributes to the parameters, Create/Update/GET/Search examples, plus a new "Disable a company's address book" section documenting the forced-cascade behavior
Navigation (src/pages/config.md)
Added the four REST pages under REST → B2B integrations → Company
Added the four GraphQL mutations under GraphQL → Schema → Company (B2B) → Mutations
Links to Magento Open Source code