API reference
Customers
Services for full management of customer registration data, their addresses and groups.
Customer Management
-
Finds a customer in your store by document and returns the complete record, with addresses and price links.
-
Registers a customer in your store, with the address and, optionally, the customer type, group and price tag links. The customer created can already access the store with the username and password provided.
-
Updates the record of a customer of your store. It is a partial update: send only the fields you want to change.
-
Activates or deactivates a customer of your store. An inactive customer cannot access the store or complete a purchase.
Addresses
-
Lists the addresses of a customer in your store.
-
Adds an address to the record of one of your store's customers.
-
Removes an address from the record of a customer of your store.
-
Removes all addresses of a customer in your store at once.
Customer Groups
-
Queries your store's customer groups by name or by external id.
-
Creates a customer group in your store. The group defines which document type it applies to and which delivery and payment methods are restricted for those in it.
-
Deletes a customer group from your store. The customers who were in the group remain registered — what is removed is the group and the links to it.
-
Links a price type to the customer. It is what makes the customer start receiving that type's price table.
-
Undoes the link between a customer and a price type. The customer stops receiving the price table of that type.
Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.