Customer Segmentation API reference corrections

Thanks to user feedback, we audited the Customer Segmentation REST reference against the live API and corrected several inaccurate response definitions for the Segments and Shopper Profiles endpoints.

  • Delete responses — Delete Segments, Delete Shopper Profiles, and Remove Shopper Profiles from Segment now correctly document a 200 response with a batch result body (data, errors, meta) and a 422 for invalid input, instead of an empty 204.
  • Validation errors — Create Segments, Update Segments, and Create Shopper Profiles now document 422 for invalid request data, instead of 400.
  • Response bodies — Create, update, add, and remove responses now document the full batch result envelope, including the data, errors, and meta (total, success, failed) fields the API returns. Paginated list responses now document the pagination links object.

For details, see the Customer Segmentation API reference.


GraphQL Schema Updates

Authenticated B2B company users can now manage their company’s addresses through the Storefront GraphQL API: add, update, and delete addresses, and look up a single address by id. The new mutations and single-address queries are alpha and marked deprecated in the schema; do not use them in production yet.

Storefront GraphQL

  • Company address mutations (alpha): new addAddress, updateAddress, and deleteAddress fields on the CompanyMutations type.
    • Inputs: updateAddress takes the new UpdateCompanyAddressInput (only provided fields are changed), and deleteAddress takes the new DeleteCompanyAddressInput; addAddress reuses the existing AddCompanyAddressInput.
    • Results: each mutation returns a matching result type (AddCompanyAddressResult, UpdateCompanyAddressResult, DeleteCompanyAddressResult) with the affected address’s entityId and a list of typed errors.
  • Single-address lookup (alpha): new address field on both the CompanyQueries and ActiveCompany types fetches one company address by entityId.
  • New address filters: the CompanyAddressFiltersInput input for the addresses connection adds city, state, country, and companyIds filters.
  • Address timestamps: the CompanyAddress type adds nullable createdAt and updatedAt fields.

For schema details, browse the Storefront GraphQL API reference.