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
200response with a batch result body (data,errors,meta) and a422for invalid input, instead of an empty204. - Validation errors — Create Segments, Update Segments, and Create Shopper Profiles now document
422for invalid request data, instead of400. - Response bodies — Create, update, add, and remove responses now document the full batch result envelope, including the
data,errors, andmeta(total,success,failed) fields the API returns. Paginated list responses now document the paginationlinksobject.
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, anddeleteAddressfields on theCompanyMutationstype.- Inputs:
updateAddresstakes the newUpdateCompanyAddressInput(only provided fields are changed), anddeleteAddresstakes the newDeleteCompanyAddressInput;addAddressreuses the existingAddCompanyAddressInput. - Results: each mutation returns a matching result type (
AddCompanyAddressResult,UpdateCompanyAddressResult,DeleteCompanyAddressResult) with the affected address’sentityIdand a list of typed errors.
- Inputs:
- Single-address lookup (alpha): new
addressfield on both theCompanyQueriesandActiveCompanytypes fetches one company address byentityId. - New address filters: the
CompanyAddressFiltersInputinput for theaddressesconnection addscity,state,country, andcompanyIdsfilters. - Address timestamps: the
CompanyAddresstype adds nullablecreatedAtandupdatedAtfields.
For schema details, browse the Storefront GraphQL API reference.