Skip to content

Added new pages for Company address book mutations - #586

Merged
keharper merged 12 commits into
AdobeDocs:mainfrom
cod40403:USF-4172
Jul 31, 2026
Merged

Added new pages for Company address book mutations#586
keharper merged 12 commits into
AdobeDocs:mainfrom
cod40403:USF-4172

Conversation

@cod40403

@cod40403 cod40403 commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

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

Comment thread src/pages/rest/b2b/create-address.md Outdated
Comment thread src/pages/rest/b2b/create-address.md Outdated
@keharper keharper added new-topic New original content internal Differentiates work between community and Adobe staff labels Jul 31, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-07-31T18:58:22.206Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-webapi/commerce-webapi
Skipped Rules:
  - check-frontmatter → src/pages/includes
  - missing-heading → src/pages/includes

───────────────────────────────────────────────────────────────

Files to process: 15

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/config.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/b2b/company/mutations/create-address.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 3:1
    Message: Description is too long (200 characters). Consider keeping it under 160 characters.
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/b2b/company/mutations/delete-address.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 3:1
    Message: Description is too long (209 characters). Consider keeping it under 160 characters.
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/b2b/company/mutations/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 21:1
    Message: Unexpected duplicate toplevel heading, exected a single heading with rank `1`
    Rule: no-multiple-toplevel-headings

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/b2b/company/mutations/set-default-address.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 3:1
    Message: Description is too long (294 characters). Consider keeping it under 160 characters.
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/graphql/schema/b2b/company/mutations/update-address.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 3:1
    Message: Description is too long (207 characters). Consider keeping it under 160 characters.
    Rule: check-frontmatter


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    15
  📄 Files with issues:  6
  ❌ Total errors:       0
  ⚠️  Total warnings:     6
  📋 Total issues:       6

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@keharper
keharper merged commit 1af3efe into AdobeDocs:main Jul 31, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Differentiates work between community and Adobe staff new-topic New original content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants